IBM Spectrum Protect

for Windows
Version 8.1.2

Installation Guide

IBM
IBM Spectrum Protect
for Windows
Version 8.1.2

Installation Guide

IBM
 Note:
Before you use this information and the product it supports, read the information in “Notices” on page 171.

This edition applies to version 8, release 1, modification 2 of IBM Spectrum Protect (product numbers 5725-W98,
5725-W99, 5725-X15), and to all subsequent releases and modifications until otherwise indicated in new editions.
© Copyright IBM Corporation 1993, 2017.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
 Contents
About this publication . . . . . . . . v Chapter 3. Taking the first steps after
Who should read this guide . . . . . . . . . v you install IBM Spectrum Protect . . . 51
Installable components . . . . . . . . . . . v Creating the user ID and directories for the server
Publications . . . . . . . . . . . . . . vi instance . . . . . . . . . . . . . . . 51
Configuring the IBM Spectrum Protect server . . . 53
What's new in this release . . . . . . vii Configuring IBM Spectrum Protect by using the
configuration wizard . . . . . . . . . . 54
Configuring the server instance manually . . . 55
Part 1. Installing and upgrading the Configuring server options for server database
server . . . . . . . . . . . . . . . 1 maintenance . . . . . . . . . . . . . . 62
Starting the server instance on Windows systems . . 63
Chapter 1. Planning to install the server 3 Configuring the server to start as a Windows
What you should know first . . . . . . . . . 3 service . . . . . . . . . . . . . . . 64
| What you should know about security before you Starting the server as a Windows service . . . 65
| install or upgrade the server . . . . . . . . . 3 Manually creating and configuring a Windows
Planning for optimal performance . . . . . . . 4 service . . . . . . . . . . . . . . . 66
Planning for the server hardware and the Starting the server in the foreground . . . . . 67
operating system . . . . . . . . . . . . 4 Starting the server in maintenance mode . . . 67
Planning for the server database disks . . . . . 7 Stopping the server . . . . . . . . . . . . 68
Planning for the server recovery log disks . . . 9 Registering licenses . . . . . . . . . . . . 68
Planning for directory-container and Specifying a device class in preparation for database
cloud-container storage pools . . . . . . . 10 backups . . . . . . . . . . . . . . . 68
Planning for storage pools in DISK or FILE Running multiple server instances on a single
device classes. . . . . . . . . . . . . 15 system . . . . . . . . . . . . . . . . 69
Planning for the correct type of storage Monitoring the server . . . . . . . . . . . 70
technology. . . . . . . . . . . . . . 18
Applying best practices to the server installation 19 Chapter 4. Installing an IBM Spectrum
Minimum system requirements for the IBM Protect server fix pack . . . . . . . . 73
Spectrum Protect server . . . . . . . . . . 20 Applying a fix pack to IBM Spectrum Protect 8.1.2
IBM Installation Manager. . . . . . . . . . 23 in a clustered environment . . . . . . . . . 75
Worksheets for planning details for the server . . . 23
Capacity planning . . . . . . . . . . . . 24
Chapter 5. Upgrading to V8.1 . . . . . 79
Estimating space requirements for the database 24
Upgrading to V8.1 . . . . . . . . . . . . 80
Recovery log space requirements . . . . . . 28
Planning the upgrade . . . . . . . . . . 80
Monitoring space utilization for the database and
Preparing the system . . . . . . . . . . 81
recovery logs . . . . . . . . . . . . . 40
Installing the server and verifying the upgrade 83
Deleting installation rollback files . . . . . . 41
Upgrading the server in a clustered environment . . 86
Server naming best practices. . . . . . . . . 42
Upgrading a V6.3 or V7.1 server to V8.1.2 in a
Installation directories . . . . . . . . . . . 44
clustered environment . . . . . . . . . . 87
Upgrading IBM Tivoli Storage Manager V6.1 to
Chapter 2. Installing the server IBM Spectrum Protect V8.1.2 in a clustered
components . . . . . . . . . . . . 45 environment . . . . . . . . . . . . . 89
Obtaining the installation package . . . . . . . 45 Removing GSKit Version 7 after upgrading to IBM
Installing IBM Spectrum Protect by using the Spectrum Protect Version 8.1.2 . . . . . . . . 92
installation wizard . . . . . . . . . . . . 46
Installing IBM Spectrum Protect by using console Chapter 6. Reverting from Version 8.1.2
mode . . . . . . . . . . . . . . . . 47
to a previous server . . . . . . . . . 95
Installing IBM Spectrum Protect in silent mode . . 48
Steps for reverting to the previous server version. . 95
Installing server language packages . . . . . . 49
Additional recovery steps if you created new
Server language locales . . . . . . . . . 49
storage pools or enabled data deduplication . . . 96
Configuring a language package . . . . . . 50
Reverting to the previous server version in a cluster
Updating a language package . . . . . . . 50
configuration . . . . . . . . . . . . . . 97
Steps for reverting to the previous server version 97

© Copyright IBM Corp. 1993, 2017 iii

Chapter 7. Reference: DB2 commands Configuring for secure communication . . . . . 133
for IBM Spectrum Protect server Securing communication between the
Operations Center and the hub server . . . . 133
databases . . . . . . . . . . . . . 99
Securing communication between the hub
server and a spoke server . . . . . . . . 135
Chapter 8. Uninstalling IBM Spectrum Resetting the password for the Operations
Protect . . . . . . . . . . . . . . 103 Center truststore file . . . . . . . . . . 136
Uninstalling IBM Spectrum Protect by using a Starting and stopping the web server . . . . . 138
graphical wizard . . . . . . . . . . . . 103 Opening the Operations Center . . . . . . . 138
Uninstalling IBM Spectrum Protect in console Collecting diagnostic information with IBM
mode . . . . . . . . . . . . . . . . 104 Spectrum Protect client management services. . . 139
Uninstalling IBM Spectrum Protect in silent mode 104 Installing the client management service by
Uninstalling and reinstalling IBM Spectrum Protect 105 using a graphical wizard . . . . . . . . 139
Uninstalling IBM Installation Manager . . . . . 106 Installing the client management service in
silent mode . . . . . . . . . . . . . 140
Verifying that the client management service is
Part 2. Installing and upgrading
installed correctly . . . . . . . . . . . 141
the Operations Center . . . . . . 107 Configuring the Operations Center to use the
client management service . . . . . . . . 142
Chapter 9. Planning to install the Starting and stopping the client management
Operations Center . . . . . . . . . 109 service. . . . . . . . . . . . . . . 143
System requirements for the Operations Center . . 109 Uninstalling the client management service . . 144
Operations Center computer requirements . . . 110 Configuring the client management service for
Hub and spoke server requirements . . . . . 110 custom client installations . . . . . . . . 144
Operating system requirements . . . . . . 113
Web browser requirements . . . . . . . . 114 Chapter 13. Uninstalling the
Language requirements . . . . . . . . . 114 Operations Center . . . . . . . . . 159
Requirements and limitations for IBM Spectrum Uninstalling the Operations Center by using a
Protect client management services . . . . . 115 graphical wizard . . . . . . . . . . . . 159
Administrator IDs that the Operations Center Uninstalling the Operations Center in console
requires . . . . . . . . . . . . . . . 116 mode . . . . . . . . . . . . . . . . 159
IBM Installation Manager . . . . . . . . . 117 Uninstalling the Operations Center in silent mode 160
Installation checklist . . . . . . . . . . . 118
Chapter 14. Rolling back to a previous
Chapter 10. Installing the Operations version of the Operations Center . . . 161
Center . . . . . . . . . . . . . . 121
Obtaining the Operations Center installation
package . . . . . . . . . . . . . . . 121 Part 3. Appendixes . . . . . . . . 163
Installing the Operations Center by using a
graphical wizard . . . . . . . . . . . . 121 Appendix A. Installation log files . . . 165
Installing the Operations Center in console mode 122
Installing the Operations Center in silent mode . . 122 Appendix B. Services associated with
the server . . . . . . . . . . . . . 167
Chapter 11. Upgrading the Operations
Center . . . . . . . . . . . . . . 125 Appendix C. Accessibility features for
the IBM Spectrum Protect product
Chapter 12. Getting started with the family. . . . . . . . . . . . . . . 169
Operations Center . . . . . . . . . 127
Configuring the Operations Center . . . . . . 127 Notices . . . . . . . . . . . . . . 171
Designating the hub server . . . . . . . . 128
Adding a spoke server . . . . . . . . . 129
Sending email alerts to administrators . . . . 129 Glossary . . . . . . . . . . . . . 175
Adding customized text to the login screen . . 132
Enabling REST services . . . . . . . . . 132 Index . . . . . . . . . . . . . . . 177

iv IBM Spectrum Protect for Windows: Installation Guide

About this publication
This publication contains installation and configuration instructions for the IBM
Spectrum Protect™ server, server languages, license, and device driver.

Instructions for installing the Operations Center are also included in this
publication.

Who should read this guide

This publication is intended for system administrators who install, configure, or
upgrade the IBM Spectrum Protect server or Operations Center.

Installable components
The IBM Spectrum Protect server and licenses are required components.

Table 1 describes all the installable components. These components are in several
different installation packages.
Table 1. IBM Spectrum Protect installable components
IBM Spectrum Protect Description Additional information
component
Server (required) Includes the database, the See Chapter 2, “Installing the server components,” on page 45.
Global Security Kit
(GSKit), IBM® Java™
Runtime Environment
(JRE), and tools to help
you configure and manage
the server.
Language package Each language package See “Installing server language packages” on page 49.
(optional) (one for each language)
contains language-specific
information for the server.
Licenses (required) Includes support for all Use the REGISTER LICENSE command.
licensed features. After you
install this package, you
must register the licenses
you purchased.
Devices (optional) Extends media A list of devices that are supported by this driver is available
management capability. from the IBM Support Portal.
Storage agent Installs the component that For more information about storage agents, see Tivoli Storage
(optional) allows client systems to Manager for Storage Area Networks (V7.1.1).
write data directly to, or
read data directly from,
storage devices that are
attached to a storage area
network (SAN).
Remember: IBM Spectrum
Protect for Storage Area
Networks is a separately
licensed product.

© Copyright IBM Corp. 1993, 2017 v

Table 1. IBM Spectrum Protect installable components (continued)
IBM Spectrum Protect Description Additional information
component
Operations Center Installs the Operations See Part 2, “Installing and upgrading the Operations Center,”
(optional) Center, which is a on page 107.
web-based interface for
managing your storage
environment.

Publications
The IBM Spectrum Protect product family includes IBM Spectrum Protect
Snapshot, IBM Spectrum Protect for Space Management, IBM Spectrum Protect for
Databases, and several other storage management products from IBM.

To view IBM product documentation, see IBM Knowledge Center.

vi IBM Spectrum Protect for Windows: Installation Guide

What's new in this release
This release of IBM Spectrum Protect introduces new features and updates.

For a list of new features and updates, see What's new.

New and changed information in this product documentation is indicated by a

vertical bar (|) to the left of the change.

© Copyright IBM Corp. 1993, 2017 vii

viii IBM Spectrum Protect for Windows: Installation Guide
Part 1. Installing and upgrading the server
Install and upgrade the IBM Spectrum Protect server.

© Copyright IBM Corp. 1993, 2017 1

2 IBM Spectrum Protect for Windows: Installation Guide
 Chapter 1. Planning to install the server
Install the server software on the computer that manages storage devices and
install the client software on every workstation that transfers data to IBM Spectrum
Protect server-managed storage.

What you should know first

Before installing IBM Spectrum Protect, be familiar with your operating systems,
storage devices, communication protocols, and system configurations.

Server maintenance releases, client software, and publications are available from
the IBM Support Portal.

Restriction: You cannot install and run the Version 8.1.2 server on a system that
already has DB2® installed on it, whether DB2 was installed by itself or as part of
some other application. The V8.1.2 server requires the installation and use of the
DB2 version that is packaged with the V8.1.2 server. No other version of DB2 can
exist on the system.

You can install the IBM Spectrum Protect server on a domain controller. The server
can have heavy processor usage, however, and that might affect and stall other
applications.

Experienced DB2 administrators can choose to perform advanced SQL queries and
use DB2 tools to monitor the database. Do not, however, use DB2 tools to change
DB2 configuration settings from those that are preset by IBM Spectrum Protect, or
alter the DB2 environment for IBM Spectrum Protect in other ways, such as with
other products. The V8.1.2 server has been built and tested extensively using the
data definition language (DDL) and database configuration that the server deploys.

Attention: Do not alter the DB2 software that is installed with IBM Spectrum
Protect installation packages and fix packs. Do not install or upgrade to a different
version, release, or fix pack of DB2 software because doing so can damage the
database.

| What you should know about security before you install or upgrade
| the server
| Before you install IBM Spectrum Protect V8.1.2 or later, review information about
| the enhanced security features and the requirements for updating your
| environment.

| About this task

| Security enhancements that were introduced in V8.12 and later enforce stricter
| security settings. To ensure that communication between servers and clients is not
| interrupted when you install or upgrade IBM Spectrum Protect software to V8.1.2,
| follow the procedure.

| Procedure
| 1. Install or upgrade the IBM Spectrum Protect servers to 8.1.2 or later.

© Copyright IBM Corp. 1993, 2017 3

 Installing the IBM Spectrum Protect server

| 2. Install or upgrade the backup-archive clients. For more information, see

| Installing and configuring clients.
| For information about scheduling deployment of client updates from the server,
| see the following documents:
| v For IBM Spectrum Protect 8.1.2 or later servers, see technote 2004596.
| v For IBM Tivoli® Storage Manager V7.1 servers and IBM Spectrum Protect
| V8.1.0 and V8.1.1 servers, see technote 1673299.
| 3. Configure the options for backup-archive clients. For more information, see
| Upgrading the IBM Spectrum Protect Server and the IBM Spectrum Protect
| Client.
|
Planning for optimal performance
Before you install the IBM Spectrum Protect server, evaluate the characteristics and
configuration of the system to ensure that the server is set up for optimal
performance.

Procedure
1. Review “What you should know first” on page 3.
2. Review each of the following sub-sections.

Planning for the server hardware and the operating system

Use the checklist to verify that the system where the server is installed meets
requirements for hardware and software configuration.

Tasks, characteristics,
Question options, or settings More information
Does the operating If you are using the Review operating system requirements at technote 1243309.
system and minimum required
hardware meet or amount of memory, you Additionally, review the guidance in Tuning tasks for operating
exceed can support a minimal systems and other applications.
requirements? workload.
For more information about requirements when these features are
v Number and in use, see the following topics:
You can experiment by
speed of
adding more system v Checklist for data deduplication
processors
memory to determine v Checklist for node replication
v System memory whether the performance
v Supported is improved. Then, decide For more information about sizing requirements for the server
operating system whether you want to keep and storage, see the IBM Spectrum Protect Blueprint.
level the system memory
dedicated to the server.
Test the memory
variations by using the
entire daily cycle of the
server workload.

If you run multiple

servers on the system,
add the requirements for
each server to get the
requirements for the
system.

4 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

Tasks, characteristics,
Question options, or settings More information
Are disks configured The amount of tuning For more information, see the following topics:
for optimal that can be done for v "Planning for server database disks"
performance? different disk systems
v "Planning for server recovery log disks"
varies. Ensure that the
appropriate queue depths v "Planning for storage pools in DISK or FILE device classes"
and other disk system
options are set.
Does the server Heavier workloads and For more information about requirements when these features are
have enough advanced features such as in use, see the following topics:
memory? data deduplication and v Checklist for data deduplication
node replication require
v Checklist for node replication
more than the minimum
system memory that is v Memory requirements
specified in the system
requirements document.

For databases that are not

enabled for data
deduplication, use the
following guidelines to
specify memory
requirements:
v For databases less than
500 GB, you need 16
GB of memory.
v For databases with a
size of 500 GB - 1 TB,
you need 24 GB of
memory.
v For databases with a
size of 1 TB - 1.5 TB,
you need 32 GB of
memory.
v For databases greater
than 1.5 TB, you need
40 GB of memory.

Ensure that you allocate

extra space for the active
log and the archive log
for replication processing.
Does the system Understand what See Tuning HBA capacity.
have enough host operations require use of
bus adapters (HBAs) HBAs at the same time.
to handle the data
operations that the For example, a server
IBM Spectrum must store 1 GB/sec of
Protect server must backup data while also
run simultaneously? doing storage pool
migration that requires 0.5
GB/sec capacity to
complete. The HBAs must
be able to handle all of
the data at the speed
required.

Chapter 1. Planning to install the IBM Spectrum Protect server 5

Installing the IBM Spectrum Protect server

Tasks, characteristics,
Question options, or settings More information
Is network Network bandwidth must For more information, see the following topics:
bandwidth greater allow the system to v Tuning network performance
than the planned complete operations such
v Checklist for node replication
maximum as backups in the time
throughput for that is allowed or that
backups? meets service level
commitments.

For node replication,

network bandwidth must
be greater than the
planned maximum
throughput.
Are you using a Use a file system that For more information, see Configuring the operating system for
preferred file system ensures optimal disk performance.
for IBM Spectrum performance and data
Protect server files? availability. The server
uses direct I/O with file
systems that support the
feature. Using direct I/O
can improve throughput
and reduce processor use.
The following list
identifies the preferred
file system:
v Use New Technology
File System (NTFS)
without compression.
Are you planning to Paging space, or swap
configure enough space, extends the
paging space? memory that is available
for processing. When the
amount of free RAM in
the system is low,
programs or data that is
not in use are moved
from memory to paging
space. This action releases
memory for other
activities, such as
database operations.

Paging space is
automatically configured.

6 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

Planning for the server database disks

Use the checklist to verify that the system where the server is installed meets
requirements for hardware and software configuration.

Tasks, characteristics, options, or

Question settings More information
Is the database on fast, low-latency Do not use the following drives for For more information, see Checklist
disks? the IBM Spectrum Protect database: for data deduplication.
v Nearline SAS (NL-SAS)
v Serial Advanced Technology
Attachment (SATA)
v Parallel Advanced Technology
Attachment (PATA)
Do not use internal disks that are
included by default in most server
hardware.

Enterprise-grade solid-state disks

(SSD), with Fibre Channel or SAS
interface, offer the best performance.

If you plan to use the data

deduplication functions of IBM
Spectrum Protect, focus on disk
performance in terms of I/O
operations per second (IOPS).
Is the database stored on disks or Separation of the server database
LUNs that are separate from disks or from other server components helps
LUNs that are used for the active log, reduce contention for the same
archive log, and storage pool resources by different operations that
volumes? must run at the same time.
Tip: The database and the archive
log can share an array when you use
solid-state drive (SSD) technology.
If you are using RAID, do you know When a system must do large
how to select the optimal RAID level numbers of writes, RAID 10
for your system? Are you defining all outperforms RAID 5. However, RAID
LUNs with the same size and type of 10 requires more disks than RAID 5
RAID? for the same amount of usable
storage.

If your disk system is RAID, define

all your LUNs with the same size
and type of RAID. For example, do
not mix 4+1 RAID 5 with 4+2 RAID
6.
If an option to set the strip size or If you can set the strip size or The block size that is used for the
segment size is available, are you segment size, use 64 KB or 128 KB database varies depending on the
planning to optimize the size when sizes on disk systems for the table space. Most table spaces use 8
you configure the disk system? database. KB blocks, but some use 32 KB
blocks.

Chapter 1. Planning to install the IBM Spectrum Protect server 7

Installing the IBM Spectrum Protect server

Tasks, characteristics, options, or

Question settings More information
Are you planning to create at least Heavier workloads and use of some For more information, see the
four directories, also called storage features require more database following topics:
paths, on four separate LUNs for the storage paths than the minimum v Checklist for data deduplication
database? requirements.
v Checklist for node replication
Create one directory per distinct Server operations such as data
For help with forecasting growth
array on the subsystem. If you have deduplication drive a high number of
when the server deduplicates data,
fewer than three arrays, create a input/output operations per second
see technote 1596944.
separate LUN volume within the (IOPS) for the database. Such
array. operations perform better when the For the most recent information
database has more directories. about database size, database
reorganization, and performance
For server databases that are larger
considerations for IBM Spectrum
than 2 TB or are expected to grow to
Protect servers, see technote 1683633.
that size, use eight directories.
For information about setting the
Consider planned growth of the
DB2_PARALLEL_IO variable, see
system when you determine how
Recommended settings for IBM DB2
many storage paths to create. The
registry variables.
server uses the higher number of
storage paths more effectively if the
storage paths are present when the
server is first created.

Use the DB2_PARALLEL_IO variable

to force parallel I/O to occur on table
spaces that have one container, or on
table spaces that have containers on
more than one physical disk. If you
do not set the DB2_PARALLEL_IO
variable, I/O parallelism is equal to
the number of containers that are
used by the table space. For example,
if a table space spans four containers,
the level of I/O parallelism that is
used is 4.
Are all directories for the database Directories that are all the same size
the same size? ensure a consistent degree of
parallelism for database operations. If
one or more directories for the
database are smaller than the others,
they reduce the potential for
optimized parallel prefetching.

This guideline also applies if you

must add storage paths after the
initial configuration of the server.
Are you planning to raise the queue The default queue depth is often too See Configuring AIX systems for disk
depth of the database LUNs on AIX® low. performance.
systems?

8 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

Planning for the server recovery log disks

Use the checklist to verify that the system where the server is installed meets
requirements for hardware and software configuration.

Tasks, characteristics, options, or

Question settings More information
Are the active log and archive log Ensure that the disks where you Separation of the server database,
stored on disks or LUNs that are place the active log are not used for active log, and archive log helps to
separate from what is used for the other server or system purposes. Do reduce contention for the same
database and storage pool volumes? not place the active log on disks that resources by different operations that
contain the server database, the must run at the same time.
archive log, or system files such as
page or swap space.
Are the logs on disks that have Nonvolatile write cache allows data
nonvolatile write cache? to be written to the logs as fast as
possible. Faster write operations for
the logs can improve performance for
server operations.
Are you setting the logs to a size that If you are not sure about the v For log sizing details, see the
adequately supports the workload? workload, use the largest size that recovery log information in
you can. technote 1421060.
Active log v For information about sizing when
The maximum size is 512 you use data deduplication, see
GB, set with the Checklist for data deduplication.
ACTIVELOGSIZE server option.
Ensure that there is at least 8
GB of free space on the
active log file system after
the fixed size active logs are
created.
Archive log
The size of the archive log is
limited by the size of the file
system on which it is
located, and not by a server
option. Make the archive log
at least as large as the active
log.
Are you defining an archive failover The archive failover log is for Use the ARCHFAILOVERLOGDIRECTORY
log? Are you placing this log on a emergency use by the server when server option to specify the location
disk that is separate from the archive the archive log becomes full. Slower of the archive failover log.
log? disks can be used for the archive
failover log. Monitor the usage of the directory for
the archive failover log. If the archive
failover log must be used by the
server, the space for the archive log
might not be large enough.

Chapter 1. Planning to install the IBM Spectrum Protect server 9

Installing the IBM Spectrum Protect server

Tasks, characteristics, options, or

Question settings More information
If you are mirroring the active log, You can mirror the log by using one If you mirror the active log, ensure
are you using only one type of of the following methods. Use only that the disks for both the active log
mirroring? one type of mirroring for the log. and the mirror copy have equal
v Use the MIRRORLOGDIRECTORY option speed and reliability.
that is available for the IBM
For more information, see
Spectrum Protect server to specify
Configuring and tuning the recovery
a mirror location.
log.
v Use software mirroring, such as
Logical Volume Manager (LVM) on
AIX.
v Use mirroring in the disk system
hardware.

Planning for directory-container and cloud-container storage

pools
Review how your directory-container and cloud-container storage pools are set up
to ensure optimal performance.

Tasks, characteristics, options, or

Question settings More information
Measured in terms of input/output Use a high-performance disk for the For recommendations about disk
operations per second (IOPS), are you database. Use solid-state drive selection, see "Planning for server
using fast disk storage for the IBM technology for data deduplication database disks".
Spectrum Protect database? processing.
For more information about IOPS, see
Ensure that the database has a the IBM Spectrum Protect Blueprints.
minimum capability of 3000 IOPS.
For each TB of data that is backed up
daily (before data deduplication), add
1000 IOPS to this minimum.

For example, an IBM Spectrum

Protect server that is ingesting 3 TB
of data per day would need 6000
IOPS for the database disks:
3000 IOPS minimum + 3000 (3
TB x 1000 IOPS) = 6000 IOPS

10 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

Tasks, characteristics, options, or

Question settings More information
Do you have enough memory for the Use a minimum of 40 GB of system Memory requirements
size of your database? memory for IBM Spectrum Protect
servers, with a database size of 100
GB, that are deduplicating data. If the
retained capacity of backup data
grows, the memory requirement
might need to be higher.

Monitor memory usage regularly to

determine whether more memory is
required.

Use more system memory to improve

caching of database pages. The
following memory size guidelines are
based on the daily amount of new
data that you back up:
v 128 GB of system memory for
daily backups of data, where the
database size is 1 - 2 TB
v 192 GB of system memory for
daily backups of data, where the
database size is 2 - 4 TB
Have you properly sized the storage Configure the server to have a For more information about sizing
capacity for the database active log minimum active log size of 128 GB for your system, see the IBM
and archive log? by setting the ACTIVELOGSIZE server Spectrum Protect Blueprints.
option to a value of 131072.

The suggested starting size for the

archive log is 1 TB. The size of the
archive log is limited by the size of
the file system on which it is located,
and not by a server option. Ensure
that there is at least 10% extra disk
space for the file system than the size
of the archive log.

Use a directory for the database

archive logs with an initial free
capacity of at least 1 TB. Specify the
directory by using the
ARCHLOGDIRECTORY server option.

Define space for the archive failover

log by using the
ARCHFAILOVERLOGDIRECTORY server
option.

Chapter 1. Planning to install the IBM Spectrum Protect server 11

Installing the IBM Spectrum Protect server

Tasks, characteristics, options, or

Question settings More information
Is compression enabled for the Enable the ARCHLOGCOMPRESS server For more information about
archive log and database backups? option to save storage space. compression for your system, see the
IBM Spectrum Protect Blueprints.
This compression option is different
from inline compression. Inline
compression is enabled by default
with IBM Spectrum Protect V7.1.5
and later.
Restriction: Do not use this option
if the amount of backed up data
exceeds 6 TB per day.
Are the IBM Spectrum Protect The database must not share disk For more information about server
database and logs on separate disk volumes with IBM Spectrum Protect database and recovery log
volumes (LUNs)? database logs or storage pools, or configuration, see Server database
with any other application or file and recovery log configuration and
Is the disk that is used for the system. tuning.
database configured according to best
practices for a transactional database?
Are you using a minimum of eight If you are planning to use client-side v Effective planning and use of
(2.2 GHz or equivalent) processor data deduplication, verify that client deduplication
cores for each IBM Spectrum Protect systems have adequate resources
v IBM Spectrum Protect Blueprints
server that you plan to use with data available during a backup operation
deduplication? to complete data deduplication
processing. Use a processor that is at
least the minimum equivalent of one
2.2 GHz processor core per backup
process with client-side data
deduplication.
Did you allocate enough storage For a rough estimate, plan for 100 GB
space for the database? of database storage for every 50 TB
of data that is to be protected in
deduplicated storage pools. Protected
data is the amount of data before data
deduplication, including all versions
of objects stored.

As a best practice, define a new

container storage pool exclusively for
data deduplication. Data
deduplication occurs at the
storage-pool level, and all data
within a storage pool, except
encrypted data, is deduplicated.

12 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

Tasks, characteristics, options, or

Question settings More information
Have you estimated storage pool You can estimate capacity For an example of using this
capacity to configure enough space requirements for a deduplicated technique, see Effective planning and
for the size of your environment? storage pool by using the following use of deduplication.
technique:
1. Estimate the base size of the
source data.
2. Estimate the daily backup size by
using an estimated change and
growth rate.
3. Determine retention requirements.
4. Estimate the total amount of
source data by factoring in the
base size, daily backup size, and
retention requirements.
5. Apply the deduplication ratio
factor.
6. Apply the compression ratio
factor.
7. Round up the estimate to
consider transient storage pool
usage.
Have you distributed disk I/O over Use arrays that consist of as many For guidelines about setting up
many disk devices and controllers? disks as possible, which is sometimes storage pools, see "Planning for
referred to as wide striping. Ensure storage pools in DISK or FILE device
that you use one database directory classes".
per distinct array on the subsystem.
For information about setting the
Set the DB2_PARALLEL_IO registry DB2_PARALLEL_IO variable, see
variable to enable parallel I/O for Recommended settings for IBM DB2
each table space used if the registry variables.
containers in the table space span
multiple physical disks.

When I/O bandwidth is available

and the files are large, for example 1
MB, the process of finding duplicates
can occupy the resources of an entire
processor. When files are smaller,
other bottlenecks can occur.

Specify eight or more file systems for

the deduplicated storage pool device
class so that I/O is distributed across
as many LUNs and physical devices
as possible.
Have you scheduled daily operations The best practice sequence of v Scheduling data deduplication and
based on your backup strategy? operations is in the following order: node replication processes
1. Client backup v Daily operations for
2. Storage pool protection directory-container storage pools
3. Node replication
4. Database backup
5. Expire inventory

Chapter 1. Planning to install the IBM Spectrum Protect server 13

Installing the IBM Spectrum Protect server

Tasks, characteristics, options, or

Question settings More information
Do you have enough storage to If you deduplicate data that includes For information about tuning the
manage the DB2 lock list? large files or large numbers of files DB2 LOCKLIST parameter, see Tuning
concurrently, the process can result in server-side data deduplication.
insufficient storage space. When the
lock list storage is insufficient,
backup failures, data management
process failures, or server outages can
occur.

File sizes greater than 500 GB that are

processed by data deduplication are
most likely to deplete storage space.
However, if many backup operations
use client-side data deduplication,
this problem can also occur with
smaller-sized files.
Is sufficient bandwidth available to To transfer data to an IBM Spectrum For more information, see the
transfer data to an IBM Spectrum Protect server, use client-side or enablededup client option.
Protect server? server-side data deduplication and
compression to reduce the bandwidth
that is required.

Use a V7.1.5 server or higher to use

inline compression and use a V7.1.6
or later client to enable enhanced
compression processing.
Have you determined how many Assign directories to a storage pool
storage pool directories to assign to by using the DEFINE
each storage pool? STGPOOLDIRECTORY command.

Create multiple storage pool

directories and ensure that each
directory is backed up to a separate
disk volume (LUN).
Did you allocate enough disk space To prevent backup failures, ensure
in the cloud-container storage pool? that the local directory has enough
space. Use the following list as a
guide for optimal disk space:
v For serial-attached SCSI (SAS) and
spinning disk, calculate the
amount of new data that is
expected after daily data reduction
(compression and data
deduplication). Allocate up to 100
percent of that amount, in
terabytes, for disk space.
v Provide 3 TB for flash-based
storage systems with fast network
connections to on-premises,
high-performance cloud systems.
v Provide 5 TB for solid-state drive
(SSD) systems with fast network
connections to high-performance
cloud systems.

14 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

Tasks, characteristics, options, or

Question settings More information
Did you select the appropriate type Ensure that data transfers from local
of local storage? storage to cloud finish before the next
backup cycle starts.
Tip: Data is removed from local
storage soon after it moves to the
cloud.

Use the following guidelines:

v Use flash or SSD for large systems
that have high-performing cloud
systems. Ensure that you have a
dedicated 10 GB wide area
network (WAN) link with a
high-speed connection to the object
storage. For example, use flash or
SSD if you have a dedicated 10 GB
WAN link plus a high-speed
connection to either an IBM Cloud
Object Storage location or to an
Amazon Simple Storage Service
(Amazon S3) data center.
v Use larger capacity 15000 rpm SAS
disks for these scenarios:
– Medium-sized systems
– Slower cloud connections, for
example, 1 GB
– When you use IBM Cloud
Object Storage as your service
provider across several regions
v For SAS or spinning disk, calculate
the amount of new data that is
expected after daily data reduction
(compression and data
deduplication). Allocate up to 100
percent of that amount for disk
space, in terabytes.

Planning for storage pools in DISK or FILE device classes

Use the checklist to review how your disk storage pools are set up. This checklist
includes tips for storage pools that use DISK or FILE device classes.

Chapter 1. Planning to install the IBM Spectrum Protect server 15

Installing the IBM Spectrum Protect server

Tasks, characteristics, options, or

Question settings More information
Can the storage pool LUNs sustain When you are planning for peak For more information, see Analyzing
throughput rates for 256 KB loads, consider all the data that you the basic performance of disk
sequential reads and writes to want the server to read or write to systems.
adequately handle the workload the disk storage pools
within the time constraints? simultaneously. For example,
consider the peak flow of data from
client backup operations and server
data-movement operations such as
migration that run at the same time.

The IBM Spectrum Protect server

reads and writes to storage pools
predominantly in 256 KB blocks.

If the disk system includes the

capability, configure the disk system
for optimal performance with
sequential read/write operations
rather than random read/write
operations.
Is the disk configured to use read Use more cache for better
and write cache? performance.
For storage pools that use FILE Review the information in Optimal Typically, problems arise more
device classes, have you determined number and size of volumes for frequently when the volumes are too
a good size to use for the storage storage pools that use disk. If you do small. Few problems are reported
pool volumes? not have the information to estimate when volumes are larger than
a size for FILE device class volumes, needed. When you determine the
start with volumes that are 50 GB. volume size to use, as a precaution
choose a size that might be larger
than necessary.
For storage pools that use FILE Scratch volumes can cause file Use the DEFINE VOLUME server
device classes, are you using fragmentation. command to preallocate volumes in
preallocated volumes? the storage pool.
To ensure that a storage pool does
not run out of volumes, set the Use the DEFINE STGPOOL or UPDATE
MAXSCRATCH parameter to a value STGPOOL server command to set the
greater than zero. MAXSCRATCH parameter.
For storage pools that use FILE Always maintain enough usable For storage pools that use FILE
device classes, have you compared volumes in the storage pools to allow device classes, only one session or
the maximum number of client for the expected peak number of process can write to a volume at the
sessions to the number of volumes client sessions that run at one time. same time.
that are defined? The volumes might be scratch
volumes, empty volumes, or partly
filled volumes.

16 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

Tasks, characteristics, options, or

Question settings More information
For storage pools that use FILE For storage pools that use data Use the REGISTER NODE or UPDATE
device classes, have you set the deduplication, the MOUNTLIMIT NODE server command to set the
MOUNTLIMIT parameter of the device parameter is typically in the range of MAXNUMMP parameter for client nodes.
class to a value that is high enough 500 - 1000.
to account for the number of volumes
that might be mounted in parallel? Set the value for MOUNTLIMIT to the
maximum number of mount points
that are needed for all active sessions.
Consider parameters that affect the
maximum number of mount points
that are needed:
v The MAXSESSIONS server option,
which is the maximum number of
IBM Spectrum Protect sessions that
can run concurrently.
v The MAXNUMMP parameter, which
sets the maximum number of
mount points that each client node
can use.
For example, if the maximum
number of client node backup
sessions is typically 100 and each of
the nodes has MAXNUMMP=2, multiply
100 nodes by the 2 mount points for
each node to get the value of 200 for
the MOUNTLIMIT parameter.
For storage pools that use DISK How you configure the storage for a For an example layout that follows
device classes, have you determined storage pool that uses a DISK device this guideline, see Sample layout of
how many storage pool volumes to class depends on whether you are server storage pools.
put on each file system? using RAID for the disk system.

If you are not using RAID, then

configure one file system per physical
disk, and define one storage pool
volume for each file system.

If you are using RAID 5 with n + 1

volumes, configure the storage in one
of the following ways:
v Configure n file systems on the
LUN and define one storage pool
volume per file system.
v Configure one file system and n
storage pool volumes for the LUN.
Did you create your storage pools to Ensure that each file system is on a For details, see the following topics:
distribute I/O across multiple file different LUN on the disk system. v Tuning disk storage for the server
systems?
Typically, having 10 - 30 file systems v Tuning and configuring storage
is a good goal, but ensure that the pools and volumes
file systems are no smaller than
approximately 250 GB.

Chapter 1. Planning to install the IBM Spectrum Protect server 17

Installing the IBM Spectrum Protect server

Planning for the correct type of storage technology

Storage devices have different capacity and performance characteristics. These
characteristics affect which devices are better for use with IBM Spectrum Protect.

Procedure

Review the following table to help you to choose the correct type of storage
technology for the storage resources that the server requires.
Table 2. Storage technology types for IBM Spectrum Protect storage requirements
Storage
technology Archive log and
type Database Active log archive failover log Storage pools
Solid-state Place the database on If you place the IBM Save SSDs for use with Save SSDs for use with
disk (SSD) SSD in the following Spectrum Protect the database and active the database and active
circumstances: database on an SSD, as log. The archive log log. Storage pools can
v You are using IBM a best practice, place and archive failover be placed on slower
Spectrum Protect the active log on an logs can be placed on storage technology
data deduplication. SSD. If space is not slower storage types.
available, use technology types.
v You are backing up
high-performance disk
more than 8 TB of
instead.
new data daily.
High- Use high-performance Use high-performance You can use Use high-performance
performance disks in the following disks in the following high-performance disks disks for storage pools
disk with the circumstances: circumstances: for the archive log and in the following
following v The server does not v The server does not archive failover logs. circumstances:
characteristics: do data do data For availability, isolate v Data is frequently
v 15k rpm deduplication. deduplication. these logs from the read.
disk database and active
v The server does not v The server does not v Data is frequently
log.
v Fibre do node replication. do node replication. written.
Channel or
serial- Isolate the server For performance and For performance and
attached database from its logs availability, isolate the availability, isolate
SCSI (SAS) and storage pools, and active log from the storage pool data from
interface from data for other server database, archive the server database and
applications. logs, and storage pools. logs, and from data for
other applications.
Medium- If the disk system has a If the disk system has a You can use Use
performance mix of disk mix of disk medium-performance medium-performance
or technologies, use the technologies, use the or high-performance or high-performance
high- faster disks for the faster disks for the disk for the archive log disk for storage pools
performance database and active database and active and archive failover in the following
disk with the log. Isolate the server log. For performance logs. For availability, circumstances:
following database from its logs and availability, isolate isolate these logs from v Data is frequently
characteristics: and storage pools, and the active log from the the database and active read.
v 10k rpm from data for other server database, archive log.
v Data is frequently
disk applications. logs, and storage pools.
written.
v Fibre
Channel or For performance and
SAS availability, isolate
interface storage pool data from
the server database and
logs, and from data for
other applications.

18 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

Table 2. Storage technology types for IBM Spectrum Protect storage requirements (continued)
Storage
technology Archive log and
type Database Active log archive failover log Storage pools
SATA, Do not use this storage Do not use this storage Use of this slower Use this slower storage
network- for the database. Do for the active log. storage technology is technology in the
attached not place the database acceptable because following
storage on XIV storage these logs are written circumstances:
systems. once and infrequently v Data is infrequently
read. written, for example
written once.
v Data is infrequently
read.
.
Tape and Use for long-term
virtual tape retention or if data is
infrequently used.

Applying best practices to the server installation

Typically, hardware configuration and selection have the most significant effect on
the performance of an IBM Spectrum Protect solution. Other factors that affect
performance are the operating system selection and configuration, and the
configuration of IBM Spectrum Protect.

Procedure
v The following best practices are the most important for optimal performance and
problem prevention.
v Review the table to determine the best practices that apply to your environment.

Best practice More information

Use fast disks for the server database. Use fast, low-latency disks for the database. Using SSD is essential
Enterprise-grade solid-state disks (SSD), with if you are using data deduplication and node replication. Avoid
Fibre Channel or SAS interface, offer the best Serial Advanced Technology Attachment (SATA) and Parallel
performance. Advanced Technology Attachment (PATA) disks. For details and
more tips, see the following topics:
v "Planning for server database disks"
v "Planning for the correct type of storage technology"
Ensure that the server system has enough Review operating system requirements in technote 1243309. Heavier
memory. workloads require more than the minimum requirements.
Advanced features such as data deduplication and node replication
can require more than the minimum memory that is specified in the
system requirements document.

If you plan to run multiple instances, each instance requires the

memory that is listed for one server. Multiply the memory for one
server by the number of instances that are planned for the system.

Chapter 1. Planning to install the IBM Spectrum Protect server 19

Installing the IBM Spectrum Protect server

Best practice More information

Separate the server database, the active log, Keep all IBM Spectrum Protect storage resources on separate disks.
the archive log, and disk storage pools from Keep storage pool disks separate from the disks for the server
each other. database and logs. Storage pool operations can interfere with
database operations when both are on the same disks. Ideally, the
server database and logs are also separated from each other. For
details and more tips, see the following topics:
v "Planning for server database disks"
v "Planning for server recovery log disks"
v "Planning for storage pools in DISK or FILE device classes"
Use at least four directories for the server Place each directory on a LUN that is isolated from other LUNs
database. For larger servers or servers that use and from other applications.
advanced features, use eight directories.
A server is considered to be large if its database is larger than 2 TB
or is expected to grow to that size. Use eight directories for such
servers.

See "Planning for server database disks".

If you are using data deduplication, node Configure the server database according to the guidelines, because
replication, or both, follow the guidelines for the database is extremely important to how well the server runs
database configuration and other items. when these features are being used. For details and more tips, see
the following topics:
v Checklist for data deduplication
v Checklist for node replication
For storage pools that use FILE type device Review the information in Optimal number and size of volumes for
classes, follow the guidelines for the size of storage pools that use disk to help you to determine volume size.
storage pool volumes. Typically, 50 GB
volumes are best. Configure storage pool devices and file systems based on
throughput requirements, not only on capacity requirements.

Isolate the storage devices that are used by IBM Spectrum Protect
from other applications that have high I/O, and ensure that there is
enough throughput to that storage.

For more details, see Checklist for storage pools on DISK or FILE.
Schedule IBM Spectrum Protect client For more details, see the following topics:
operations and server maintenance activities to v Tuning the schedule for daily operations
avoid or minimize overlap of operations.
v Checklist for server configuration
Monitor operations constantly. By monitoring, you can find problems early and more easily
identify causes. Keep records of monitoring reports for up to a year
to help you identify trends and plan for growth. See Monitoring
and maintaining the environment for performance.

Minimum system requirements for the IBM Spectrum Protect server

The server can require a large amount of memory, network bandwidth, and
processor resources. In many cases, the server performs best when other
applications are not installed on the same system.

Hardware and software requirements for the IBM Spectrum

Protect server installation

These tables list the minimum hardware and software requirements for the
installation of an IBM Spectrum Protect server. Use these requirements as a starting
point for systems without data deduplication. The optimal IBM Spectrum Protect

20 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

environment is set up with data deduplication by using the IBM Spectrum Protect
Blueprints. For the most current information about system requirements, see
technote 1243309.

Hardware requirements

Table 3 describes the minimum hardware requirements for the server. If the server
does not meet the minimum requirements, the installation fails. For more details
about planning disk space, see “Capacity planning” on page 24.
Table 3. Hardware requirements
Type of
hardware Hardware requirements
Hardware An AMD64 or Intel EMT-64 processor
Disk Space The following minimum values for disk space:
v At least 7.5 GB of free disk storage for a typical installation
v 60 MB in the temporary directory space
v 2 GB partition size in the C:\ drive
v 300 MB in the instance directory
v 2 GB for the shared resources area

In case a problem arises and any diagnosis is needed, it is optimal to have

temporary or other space available on the system for a first failure data
capture (FFDC) log or for other temporary uses such as for collecting trace
logs.

Significant additional disk space is required for database and log files. The
size of the database depends on the number of client files to be stored and
the method by which the server manages them. The default active log
space is 16 GB, the minimum that is needed for most workloads and
configurations. When you create the active log, you need at least 64 GB to
run replication. If replication and data deduplication are both being used,
create an active log of 128 GB. Allocate at least three times the default
active log space for the archive log (48 GB). Ensure that you have sufficient
resources if you are using data deduplication or expect a heavy client
workload.

For optimal performance and to facilitate I/O, specify at least two equally
sized containers or Logical Unit Numbers (LUNs) for the database. In
addition, each active log and archive log needs its own container or LUN.

Ensure that you see “Capacity planning” on page 24 for more details about
disk space.
Memory The following minimum values for memory:
v 16 GB for standard server operations without data deduplication and
node replication
v 24 GB for data deduplication or node replication
v 32 GB for node replication with data deduplication
For more specific memory requirements for larger databases and higher
ingestion capability, see the IBM Spectrum Protect server memory tuning
table.

For more specific memory requirements when you are using data
deduplication, see the IBM Spectrum Protect Blueprint for your operating
system.

Chapter 1. Planning to install the IBM Spectrum Protect server 21

 Installing the IBM Spectrum Protect server

Software requirements

Table 4 describes the minimum software requirements that are needed for a server
on a Windows system.
Table 4. Software requirements
Type of
software Minimum software requirements
Operating One of the following operating systems:
system v Microsoft Windows Server 2012: Standard, Enterprise, or Datacenter
Edition (64-bit)
v Microsoft Windows Server 2012 R2 (64-bit)
| v Microsoft Windows Server 2016
Communication At least one of the following communication protocols (installed by
protocol default with the current Windows operating systems):
v Named Pipes
v TCP/IP Version 4 or Version 6
Device drivers The IBM Spectrum Protect passthru device driver that is required for
non-IBM drives and tape libraries. The Windows native device driver is
recommended for tape drives and tape libraries. Otherwise, the IBM
Spectrum Protect kernel device driver can be used.

For the IBM 3590, 3592, or the Ultrium tape library or drives, the IBM
device drivers are required. Install the most current device drivers. You
can locate IBM driver packages at Fix Central.

Configure the device drivers before you use the server with tape devices.
| Other software Windows 2012, Windows 2012 R2, and Windows 2016 require that .NET
| Framework 3.5 is installed and enabled.

| The following User Account Control policies must be disabled:

| v User Account Control: Admin Approval Mode for the Built-in
| Administrator account
| v User Account Control: Run all administrators in Admin Approval
| Mode

| To authenticate IBM Spectrum Protect users with a Lightweight Directory

| Access Protocol (LDAP) server, you must use one of the following
| directory servers:
| v Microsoft Active Directory (Windows Server 2012, Windows Server
| 2012 R2)
| v IBM Security Directory Server V6.3
| v IBM Security Directory Server V6.4

22 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

IBM Installation Manager

IBM Spectrum Protect uses IBM Installation Manager, which is an installation
program that can use remote or local software repositories to install or update
many IBM products.

If the required version of IBM Installation Manager is not already installed, it is

automatically installed or upgraded when you install IBM Spectrum Protect. It
must remain installed on the system so that IBM Spectrum Protect can be updated
or uninstalled later as needed.

The following list contains explanations of some terms that are used in IBM
Installation Manager:
Offering
An installable unit of a software product.
The IBM Spectrum Protect offering contains all of the media that IBM
Installation Manager requires to install IBM Spectrum Protect.
Package
The group of software components that are required to install an offering.
The IBM Spectrum Protect package contains the following components:
v IBM Installation Manager installation program
v IBM Spectrum Protect offering
Package group
A set of packages that share a common parent directory.
The default package group for the IBM Spectrum Protect package is IBM
Installation Manager.
Repository
A remote or local storage area for data and other application resources.
The IBM Spectrum Protect package is stored in a repository on IBM Fix
Central.
Shared resources directory
A directory that contains software files or plug-ins that are shared by
packages.
IBM Installation Manager stores installation-related files in the shared
resources directory, including files that are used for rolling back to a
previous version of IBM Spectrum Protect.

Worksheets for planning details for the server

You can use the worksheets to help you plan the amount and location of storage
needed for the IBM Spectrum Protect server. You can also use them to keep track
of names and user IDs.

Restriction: If you are using a File Allocation Table (FAT or FAT32) or a New
Technology File System (NTFS) format, you cannot specify the root directory of
that system as the location of a database directory or log directory. Instead, you
must create one or more subdirectories within the root directory. Then, create the
database directories and log directories within the subdirectories.

Chapter 1. Planning to install the IBM Spectrum Protect server 23

Installing the IBM Spectrum Protect server

Item Space required Number of directories Location of directories

The database
Active log
Archive log
Optional: Log mirror for
the active log
Optional: Secondary
archive log (failover
location for archive log)

Item Names and user IDs Location

The instance user ID for the
server, which is the ID you use
to start and run the IBM
Spectrum Protect server
The home directory for the server,
which is the directory that
contains the instance user ID
The database instance name
The instance directory for the
server, which is a directory that
contains files specifically for this
server instance (the server
options file and other
server-specific files)
The server name, use a unique
name for each server

Capacity planning
Capacity planning for IBM Spectrum Protect includes managing resources such as
the database, the recovery log and the shared resource area. To maximize resources
as part of capacity planning, you must estimate space requirements for the
database and the recovery log. The shared resource area must have enough space
available for each installation or upgrade.

Estimating space requirements for the database

To estimate space requirements for the database, you can use the maximum
number of files that can be in server storage at one time or you can use storage
pool capacity.

About this task

Consider using at least 25 GB for the initial database space. Provision file system
space appropriately. A database size of 25 GB is adequate for a test environment or
a library-manager-only environment. For a production server supporting client
workloads, the database size is expected to be larger. If you use random-access
disk (DISK) storage pools, more database and log storage space is needed than for
sequential-access storage pools.

The maximum size of the IBM Spectrum Protect database is 6 TB.

24 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

For information about sizing the database in a production environment that is

based on the number of files and on storage pool size, see the following topics.

Estimating database space requirements based on the number of

files
If you can estimate the maximum number of files that might be in server storage at
a time, you can use that number to estimate space requirements for the database.

About this task

To estimate space requirements that is based on the maximum number of files in

server storage, use the following guidelines:
v 600 - 1000 bytes for each stored version of a file, including image backups.

Restriction: The guideline does not include space that is used during data
deduplication.
v 100 - 200 bytes for each cached file, copy storage pool file, active-data pool file,
and deduplicated file.
v Additional space is required for database optimization to support varying
data-access patterns and to support server back-end processing of the data. The
amount of extra space is equal to 50% of the estimate for the total number of
bytes for file objects.

In the following example for a single client, the calculations are based on the
maximum values in the preceding guidelines. The examples do not take into
account that you might use file aggregation. In general, when you aggregate small
files, it reduces the amount of required database space. File aggregation does not
affect space-managed files.

Procedure
1. Calculate the number of file versions. Add each of the following values to
obtain the number of file versions:
a. Calculate the number of backed-up files. For example, as many as 500,000
client files might be backed up at a time. In this example, storage policies
are set to keep up to three copies of backed up files:
500,000 files * 3 copies = 1,500,000 files
b. Calculate the number of archive files. For example, as many as 100,000
client files might be archived copies.
c. Calculate the number of space-managed files. For example, as many as
200,000 client files might be migrated from client workstations.
Using 1000 bytes per file, the total amount of database space that is required
for the files that belong to the client is 1.8 GB:
(1,500,000 + 100,000 + 200,000) * 1000 = 1.8 GB
2. Calculate the number of cached files, copy storage-pool files, active-data pool
files, and deduplicated files:
a. Calculate the number of cached copies. For example, caching is enabled in a
5 GB disk storage pool. The high migration threshold of the pool is 90%
and the low migration threshold of the pool is 70%. Thus, 20% of the disk
pool, or 1 GB, is occupied by cached files.
If the average file size is about 10 KB, approximately 100,000 files are in
cache at any one time:
100,000 files * 200 bytes = 19 MB

Chapter 1. Planning to install the IBM Spectrum Protect server 25

Installing the IBM Spectrum Protect server

b. Calculate the number of copy storage-pool files. All primary storage pools
are backed up to the copy storage pool:
(1,500,000 + 100,000 + 200,000) * 200 bytes = 343 MB
c. Calculate the number of active storage-pool files. All the active
client-backup data in primary storage pools is copied to the active-data
storage pool. Assume that 500,000 versions of the 1,500,000 backup files in
the primary storage pool are active:
500,000 * 200 bytes = 95 MB
d. Calculate the number of deduplicated files. Assume that a deduplicated
storage pool contains 50,000 files:
50,000 * 200 bytes = 10 MB
Based on the preceding calculations, about 0.5 GB of extra database space is
required for the client’s cached files, copy storage-pool files, active-data pool
files, and deduplicated files.
3. Calculate the amount of extra space that is required for database optimization.
To provide optimal data access and management by the server, extra database
space is required. The amount of extra database space is equal to 50% of the
total space requirements for file objects.
(1.8 + 0.5) * 50% = 1.2 GB
4. Calculate the total amount of database space that is required for the client. The
total is approximately 3.5 GB:
1.8 + 0.5 + 1.2 = 3.5 GB
5. Calculate the total amount of database space that is required for all clients. If
the client that was used in the preceding calculations is typical and you have
500 clients, for example, you can use the following calculation to estimate the
total amount of database space that is required for all clients:
500 * 3.5 = 1.7 TB

Results

Tip: In the preceding examples, the results are estimates. The actual size of the
database might differ from the estimate because of factors such as the number of
directories and the length of the path and file names. Periodically monitor your
database and adjust its size as necessary.

What to do next

During normal operations, the IBM Spectrum Protect server might require
temporary database space. This space is needed for the following reasons:
v To hold the results of sorting or ordering that are not already being kept and
optimized in the database directly. The results are temporarily held in the
database for processing.
v To give administrative access to the database through one of the following
methods:
– A DB2 open database connectivity (ODBC) client
– An Oracle Java database connectivity (JDBC) client
– Structured Query Language (SQL) to the server from an administrative-client
command line

Consider using an extra 50 GB of temporary space for every 500 GB of space for
file objects and optimization. See the guidelines in the following table. In the
example that is used in the preceding step, a total of 1.7 TB of database space is

26 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

required for file objects and optimization for 500 clients. Based on that calculation,
200 GB is required for temporary space. The total amount of required database
space is 1.9 TB.

Database size Minimum temporary-space requirement

< 500 GB 50 GB
≥ 500 GB and < 1 TB 100 GB
≥ 1 TB and < 1.5 TB 150 GB
≥ 1.5 and < 2 TB 200 GB
≥ 2 and < 3 TB 250 - 300 GB
≥ 3 and < 4 TB 350 - 400 GB

Estimating database space requirements based on storage pool

capacity
To estimate database space requirements based on storage pool capacity, use a ratio
of 1 - 5%. For example, if you require 200 TB of storage pool capacity, the size of
your database is expected to be 2 - 10 TB. As a general rule, make your database
as large as possible to prevent running out of space. If you run out of database
space, server operations and client-store operations can fail.

The database manager and temporary space

The IBM Spectrum Protect server database manager manages and allocates system
memory and disk space for the database. The amount of database space you
require depends on the amount of system memory available and the server
workload.

The database manager sorts data in a specific sequence, according to the SQL
statement that you issue to request the data. Depending on the workload on the
server, and if there is more data than the database manager can manage, the data
(that is ordered in sequence) is allocated to temporary disk space. Data is allocated
to temporary disk space when there is a large result set. The database manager
dynamically manages the memory that is used when data is allocated to temporary
disk space.

For example, expiration processing can produce a large result set. If there is not
enough system memory on the database to store the result set, some of the data is
allocated to temporary disk space. During expiration processing, if a node or file
space are selected that are too large to process, the database manager cannot sort
the data in memory. The database manager must use temporary space to sort data.

To run database operations, consider adding more database space for the following
scenarios:
v The database has a small amount of space and the server operation that requires
temporary space uses the remaining free space.
v The file spaces are large, or the file spaces have an assigned policy that creates
many file versions.
v The IBM Spectrum Protect server must run with limited memory. The database
uses the IBM Spectrum Protect server main memory to run database operations.
However, if there is insufficient memory available, the IBM Spectrum Protect
server allocates temporary space on disk to the database. For example, if 10G of
memory is available and database operations require 12G of memory, the
database uses temporary space.

Chapter 1. Planning to install the IBM Spectrum Protect server 27

Installing the IBM Spectrum Protect server

v An out of database space error is displayed when you deploy an IBM

Spectrum Protect server. Monitor the server activity log for messages that are
related to database space.

Important: Do not change the DB2 software that is installed with the IBM
Spectrum Protect installation packages and fix packs. Do not install or upgrade to
a different version, release, or fix pack, of DB2 software to avoid damage to the
database.

Recovery log space requirements

In IBM Spectrum Protect, the term recovery log comprises the active log, the archive
log, the active log mirror, and the archive failover log. The amount of space that
you require for the recovery log depends on various factors, including, for
example, the amount of client activity with the server.

Active and archive log space

When you estimate space requirements for active and archive logs, include some
extra space for contingencies such as occasional heavy workloads and failovers.

In IBM Spectrum Protect servers V7.1 and later, the active log can be a maximum
size of 512 GB. The archive log size is limited to the size of the file system that it is
installed on.

Use the following general guidelines when you estimate the size of the active log:
v The suggested starting size for the active log is 16 GB.
v Ensure that the active log is at least large enough for the amount of concurrent
activity that the server typically handles. As a precaution, try to anticipate the
largest amount of work that the server manages at one time. Provision the active
log with extra space that can be used if needed. Consider using 20% of extra
space.
v Monitor used and available active log space. Adjust the size of the active log as
needed, depending upon factors such as client activity and the level of server
operations.
v Ensure that the directory that holds the active log is as large as, or larger than,
the size of the active log. A directory that is larger than the active log can
accommodate failovers, if they occur.
v Ensure that the file system that contains the active log directory has at least 8
GB of free space for temporary log movement requirements.

The suggested starting size for the archive log is 48 GB.

The archive log directory must be large enough to contain the log files that are
generated since the previous full backup. For example, if you perform a full
backup of the database every day, the archive log directory must be large enough
to hold the log files for all the client activity that occurs during 24 hours. To
recover space, the server deletes obsolete archive log files after a full backup of the
database. If the archive log directory becomes full and a directory for archive
failover logs does not exist, log files remain in the active log directory. This
condition can cause the active log directory to fill up and stop the server. When the
server restarts, some of the existing active-log space is released.

After the server is installed, you can monitor archive log utilization and the space
in the archive log directory. If the space in the archive log directory fills up, it can
cause the following problems:

28 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

v The server is unable to perform full database backups. Investigate and resolve
this problem.
v Other applications write to the archive log directory, exhausting the space that is
required by the archive log. Do not share archive log space with other
applications including other IBM Spectrum Protect servers. Ensure that each
server has a separate storage location that is owned and managed by that
specific server.

Example: Estimating active and archive log sizes for basic client-store
operations:

Basic client-store operations include backup, archive, and space management. Log
space must be sufficient to handle all store transactions that are in progress at one
time.

To determine the sizes of the active and archive logs for basic client-store
operations, use the following calculation:
number of clients x files stored during each transaction
x log space needed for each file

This calculation is used in the example in the following table.

Table 5. Basic client-store operations
Example
Item values Description
Maximum number of client nodes 300 The number of client nodes that back up, archive, or migrate
that back up, archive, or migrate files files every night.
concurrently at any time
Files stored during each transaction 4096 The default value of the server option TXNGROUPMAX is 4096.
Log space that is required for each 3053 bytes The value of 3053 bytes for each file in a transaction
file represents the log bytes that are needed when backing up
files from a Windows client where the file names are 12 -
120 bytes.

This value is based on the results of tests performed under

laboratory conditions. The tests consisted of backup-archive
clients performing backup operations to a random-access
disk (DISK) storage pool. DISK pools result in more log use
than sequential-access storage pools. Consider a value larger
than 3053 bytes if the data being stored has file names that
are longer than 12 - 120 bytes.
1
Active log: Suggested size 19.5 GB Use the following calculation to determine the size of the
active log. One GB equals 1,073,741,824 bytes.

(300 clients x 4096 files stored during each

transaction x 3053 bytes for each file) ÷ 1,073,741,824
bytes = 3.5 GB

Increase that amount by the suggested starting size of 16

GB:

3.5 + 16 = 19.5 GB

Chapter 1. Planning to install the IBM Spectrum Protect server 29

Installing the IBM Spectrum Protect server

Table 5. Basic client-store operations (continued)

Example
Item values Description
1
Archive log: Suggested size 58.5 GB Because of the requirement to be able to store archive logs
across three server database-backup cycles, multiply the
estimate for the active log by 3 to estimate the total archive
log requirement.

3.5 x 3 = 10.5 GB

Increase that amount by the suggested starting size of 48

GB:

10.5 + 48 = 58.5 GB
1
The example values in this table are used only to illustrate how the sizes for active logs and archive logs are
calculated. In a production environment that does not use deduplication, 16 GB is the suggested minimum size for
an active log. The suggested minimum size for an archive log in a production environment that does not use
deduplication is 48 GB. If you substitute values from your environment and the results are larger than 16 GB and 48
GB, use your results to size the active log and archive log.

Monitor your logs and adjust their size if necessary.

Example: Estimating active and archive log sizes for clients that use multiple
sessions:

If the client option RESOURCEUTILIZATION is set to a value that is greater than the
default, the concurrent workload for the server increases.

To determine the sizes of the active and archive logs when clients use multiple
sessions, use the following calculation:
number of clients x sessions for each client x files stored
during each transaction x log space needed for each file

This calculation is used in the example in the following table.

Table 6. Multiple client sessions
Item Example values Description
Maximum number of client 300 1000 The number of client nodes that back up, archive, or
nodes that back up, archive, migrate files every night.
or migrate files concurrently
at any time
Possible sessions for each 3 3 The setting of the client option RESOURCEUTILIZATION is
client larger than the default. Each client session runs a maximum
of three sessions in parallel.
Files stored during each 4096 4096 The default value of the server option TXNGROUPMAX is 4096.
transaction

30 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

Table 6. Multiple client sessions (continued)

Item Example values Description
Log space that is required for 3053 3053 The value of 3053 bytes for each file in a transaction
each file represents the log bytes needed when backing up files from
a Windows client where the file names are 12 - 120 bytes.

This value is based on the results of tests performed under

laboratory conditions. Tests consisted of clients performing
backup operations to a random-access disk (DISK) storage
pool. DISK pools result in more log use than
sequential-access storage pools. Consider a value larger
than 3053 bytes if the data being stored has file names that
are longer than 12 - 120 bytes.
1 1
Active log: Suggested size 26.5 GB 51 GB The following calculation was used for 300 clients. One GB
equals 1,073,741,824 bytes.

(300 clients x 3 sessions for each client x 4096 files

stored during each transaction x 3053 bytes for each
file) ÷ 1,073,741,824 = 10.5 GB

Increase that amount by the suggested starting size of 16

GB:

10.5 + 16 = 26.5 GB

The following calculation was used for 1000 clients. One

GB equals 1,073,741,824 bytes.

(1000 clients x 3 sessions for each client x 4096

files store during each transaction x 3053 bytes for
each file) ÷ 1,073,741,824 = 35 GB

Increase that amount by the suggested starting size of 16

GB:

35 + 16 = 51 GB
1 1
Archive log: Suggested size 79.5 GB 153 GB Because of the requirement to be able to store archive logs
across three server-database backup cycles, the estimate for
the active log is multiplied by 3:

10.5 x 3 = 31.5 GB

35 x 3 = 105 GB

Increase those amounts by the suggested starting size of 48

GB:

31.5 + 48 = 79.5 GB

105 + 48 = 153 GB
1
The example values in this table are used only to illustrate how the sizes for active logs and archive logs are
calculated. In a production environment that does not use deduplication, 16 GB is the suggested minimum size for
an active log. The suggested minimum size for an archive log in a production environment that does not use
deduplication is 48 GB. If you substitute values from your environment and the results are larger than 16 GB and 48
GB, use your results to size the active log and archive log.

Monitor your active log and adjust its size if necessary.

Chapter 1. Planning to install the IBM Spectrum Protect server 31

Installing the IBM Spectrum Protect server

Example: Estimating active and archive log sizes for simultaneous write
operations:

If client backup operations use storage pools that are configured for simultaneous
write, the amount of log space that is required for each file increases.

The log space that is required for each file increases by about 200 bytes for each
copy storage pool that is used for a simultaneous write operation. In the example
in the following table, data is stored to two copy storage pools in addition to a
primary storage pool. The estimated log size increases by 400 bytes for each file. If
you use the suggested value of 3053 bytes of log space for each file, the total
number of required bytes is 3453.

This calculation is used in the example in the following table.

Table 7. Simultaneous write operations
Example
Item values Description
Maximum number of client nodes 300 The number of client nodes that back up, archive, or migrate
that back up, archive, or migrate files files every night.
concurrently at any time
Files stored during each transaction 4096 The default value of the server option TXNGROUPMAX is 4096.
Log space that is required for each 3453 bytes 3053 bytes plus 200 bytes for each copy storage pool.
file
The value of 3053 bytes for each file in a transaction
represents the log bytes that are needed when backing up
files from a Windows client where the file names are 12 - 120
bytes.

This value is based on the results of tests performed under

laboratory conditions. The tests consisted of backup-archive
clients performing backup operations to a random-access
disk (DISK) storage pool. DISK pools result in more log use
than sequential-access storage pools. Consider a value larger
than 3053 bytes if the data being stored has file names that
are longer than 12 - 120 bytes.
1
Active log: Suggested size 20 GB Use the following calculation to determine the size of the
active log. One GB equals 1,073,741,824 bytes.

(300 clients x 4096 files stored during each

transaction x 3453 bytes for each file) ÷ 1,073,741,824
bytes = 4.0 GB

Increase that amount by the suggested starting size of 16 GB:

4 + 16 = 20 GB
1
Archive log: Suggested size 60 GB Because of the requirement to be able to store archive logs
across three server database-backup cycles, multiply the
estimate for the active log by 3 to estimate the archive log
requirement:

4 GB x 3 = 12 GB

Increase that amount by the suggested starting size of 48 GB:

12 + 48 = 60 GB

32 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

Table 7. Simultaneous write operations (continued)

Example
Item values Description
1
The example values in this table are used only to illustrate how the sizes for active logs and archive logs are
calculated. In a production environment that does not use deduplication, 16 GB is the suggested minimum size for
an active log. The suggested minimum size for an archive log in a production environment that does not use
deduplication is 48 GB. If you substitute values from your environment and the results are larger than 16 GB and 48
GB, use your results to size the active log and archive log.

Monitor your logs and adjust their size if necessary.

Example: Estimating active and archive log sizes for basic client store operations
and server operations:

Migration of data in server storage, identification processes for data deduplication,

reclamation, and expiration might run concurrently with client store operations.
Administrative tasks such as administrative commands or SQL queries from
administrative clients can also run concurrently with client store operations. Server
operations and administrative tasks that run concurrently can increase the active
log space that is required.

For example, migration of files from the random-access (DISK) storage pool to a
sequential-access disk (FILE) storage pool uses approximately 110 bytes of log
space for each file that is migrated. For example, suppose that you have 300
backup-archive clients and each one of them backs up 100,000 files every night.
The files are initially stored on DISK and then migrated to a FILE storage pool. To
estimate the amount of active log space that is required for the data migration, use
the following calculation. The number of clients in the calculation represents the
maximum number of client nodes that back up, archive, or migrate files
concurrently at any time.
300 clients x 100,000 files for each client x 110 bytes = 3.1 GB

Add this value to the estimate for the size of the active log that calculated for basic
client store operations.

Example: Estimating active and archive log sizes under conditions of extreme
variation:

Problems with running out of active log space can occur if you have many
transactions that complete quickly and some transactions that take much longer to
complete. A typical case occurs when many workstation or file-server backup
sessions are active and a few very large database server-backup sessions are active.
If this situation applies to your environment, you might need to increase the size
of the active log so that the work completes successfully.

Chapter 1. Planning to install the IBM Spectrum Protect server 33

Installing the IBM Spectrum Protect server

Example: Estimating archive log sizes with full database backups:

The IBM Spectrum Protect server deletes unnecessary files from the archive log
only when a full database backup occurs. Consequently, when you estimate the
space that is required for the archive log, you must also consider the frequency of
full database backups.

For example, if a full database backup occurs once a week, the archive log space
must be able to contain the information in the archive log for a full week.

The difference in archive log size for daily and full database backups is shown in
the example in the following table.
Table 8. Full database backups
Example
Item values Description
Maximum number of client nodes 300 The number of client nodes that back up, archive, or migrate
that back up, archive, or migrate files files every night.
concurrently at any time
Files stored during each transaction 4096 The default value of the server option TXNGROUPMAX is 4096.
Log space that is required for each 3453 bytes 3053 bytes for each file plus 200 bytes for each copy storage
file pool.

The value of 3053 bytes for each file in a transaction

represents the log bytes needed when backing up files from
a Windows client where the file names are 12 - 120 bytes.

This value is based on the results of tests performed under

laboratory conditions. Tests consisted of clients performing
backup operations to a random-access disk (DISK) storage
pool. DISK pools result in more log use than
sequential-access storage pools. Consider a value larger than
3053 bytes if the data being stored has file names that are
longer than 12 - 120 bytes.
1
Active log: Suggested size 20 GB Use the following calculation to determine the size of the
active log. One GB equals 1,073,741,824 bytes.

(300 clients x 4096 files per transaction x 3453 bytes

per file) ÷ 1,073,741,824 bytes = 4.0 GB

Increase that amount by the suggested starting size of 16

GB:

4 + 16 = 20 GB
1
Archive log: Suggested size with a 60 GB Because of the requirement to be able to store archive logs
full database backup every day across three backup cycles, multiply the estimate for the
active log by 3 to estimate the total archive log requirement:

4 GB x 3 = 12 GB

Increase that amount by the suggested starting size of 48

GB:

12 + 48 = 60 GB

34 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

Table 8. Full database backups (continued)

Example
Item values Description
1
Archive log: Suggested size with a 132 GB Because of the requirement to be able to store archive logs
full database every week across three server database-backup cycles, multiply the
estimate for the active log by 3 to estimate the total archive
log requirement. Multiply the result by the number of days
between full database backups:

(4 GB x 3 ) x 7 = 84 GB

Increase that amount by the suggested starting size of 48

GB:

84 + 48 = 132 GB
1
The example values in this table are used only to illustrate how the sizes for active logs and archive logs are
calculated. In a production environment that does not use deduplication, 16 GB is the suggested minimum size for
an active log. The suggested starting size for an archive log in a production environment that does not use
deduplication is 48 GB. If you substitute values from your environment and the results are larger than 16 GB and 48
GB, use your results to size the active log and archive log.

Monitor your logs and adjust their size if necessary.

Example: Estimating active and archive log sizes for data deduplication
operations:

If you deduplicate data, you must consider its effects on space requirements for
active and archive logs.

The following factors affect requirements for active and archive log space:
The amount of deduplicated data
The effect of data deduplication on the active log and archive log space
depends on the percentage of data that is eligible for deduplication. If the
percentage of data that can be deduplicated is relatively high, more log
space is required.
The size and number of extents
Approximately 1,500 bytes of active log space are required for each extent
that is identified by a duplicate-identification process. For example, if
250,000 extents are identified by a duplicate-identification process, the
estimated size of the active log is 358 MB:
250,000 extents identified during each process x 1,500 bytes
for each extent = 358 MB

Consider the following scenario. Three hundred backup-archive clients

back up 100,000 files each night. This activity creates a workload of
30,000,000 files. The average number of extents for each file is two.
Therefore, the total number of extents is 60,000,000, and the space
requirement for the archive log is 84 GB:
60,000,000 extents x 1,500 bytes for each extent = 84 GB
A duplicate-identification process operates on aggregates of files. An
aggregate consists of files that are stored in a given transaction, as
specified by the TXNGROUPMAX server option. Suppose that the TXNGROUPMAX
server option is set to the default of 4096. If the average number of extents
for each file is two, the total number of extents in each aggregate is 8192,
and the space required for the active log is 12 MB:
Chapter 1. Planning to install the IBM Spectrum Protect server 35
Installing the IBM Spectrum Protect server

8192 extents in each aggregate x 1500 bytes for each extent =

12 MB
The timing and number of the duplicate-identification processes
The timing and number of duplicate-identification processes also affects the
size of the active log. Using the 12 MB active-log size that was calculated
in the preceding example, the concurrent load on the active log is 120 MB
if 10 duplicate-identification processes are running in parallel:
12 MB for each process x 10 processes = 120 MB
File size
Large files that are processed for duplicate identification can also affect the
size of the active log. For example, suppose that a backup-archive client
backs up an 80 GB, file-system image. This object can have a high number
of duplicate extents if, for example, the files included in the file system
image were backed up incrementally. For example, assume that a file
system image has 1.2 million duplicate extents. The 1.2 million extents in
this large file represent a single transaction for a duplicate-identification
process. The total space in the active log that is required for this single
object is 1.7 GB:
1,200,000 extents x 1,500 bytes for each extent = 1.7 GB

If other, smaller duplicate-identification processes occur at the same time as

the duplicate-identification process for a single large object, the active log
might not have enough space. For example, suppose that a storage pool is
enabled for deduplication. The storage pool has a mixture of data,
including many relatively small files that range from 10 KB to several
hundred KB. The storage pool also has few large objects that have a high
percentage of duplicate extents.
To take into account not only space requirements but also the timing and
duration of concurrent transactions, increase the estimated size of the
active log by a factor of two. For example, suppose that your calculations
for space requirements are 25 GB (23.3 GB + 1.7 GB for deduplication of a
large object). If deduplication processes are running concurrently, the
suggested size of the active log is 50 GB. The suggested size of the archive
log is 150 GB.
The examples in the following tables show calculations for active and
archive logs. The example in the first table uses an average size of 700 KB
for extents. The example in the second table uses an average size of 256
KB. As the examples show, the average deduplicate-extent size of 256 KB
indicates a larger estimated size for the active log. To minimize or prevent
operational problems for the server, use 256 KB to estimate the size of the
active log in your production environment.
Table 9. Average duplicate-extent size of 700 KB
Item Example values Description
Size of largest single 800 GB 4 TB The granularity of processing for deduplication is at the file
object to deduplicate level. Therefore, the largest single file to deduplicate
represents the largest transaction and a correspondingly
large load on the active and archive logs.
Average size of 700 KB 700 KB The deduplication algorithms use a variable block method.
extents Not all deduplicated extents for a given file are the same
size, so this calculation assumes an average size for extents.

36 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

Table 9. Average duplicate-extent size of 700 KB (continued)

Item Example values Description
Extents for a given 1,198,372 6,135,667 bits Using the average extent size (700 KB), these calculations
file bits represent the total number of extents for a given object.

The following calculation was used for an 800 GB object:

(800 GB ÷ 700 KB) = 1,198,372 bits

The following calculation was used for a 4 TB object: (4 TB ÷

700 KB) = 6,135,667 bits
Active log: Suggested 1.7 GB 8.6 GB The estimated active log space that are needed for this
size that is required transaction.
for the deduplication
of a single large object
during a single
duplicate-
identification process
1 1
Active log: Suggested 66 GB 79.8 GB After considering other aspects of the workload on the
total size server in addition to deduplication, multiply the existing
estimate by a factor of two. In these examples, the active log
space required to deduplicate a single large object is
considered along with previous estimates for the required
active log size.

The following calculation was used for multiple transactions

and an 800 GB object:

(23.3 GB + 1.7 GB) x 2 = 50 GB

Increase that amount by the suggested starting size of 16 GB:

50 + 16 = 66 GB

The following calculation was used for multiple transactions

and a 4 TB object:

(23.3 GB + 8.6 GB) x 2 = 63.8 GB

Increase that amount by the suggested starting size of 16 GB:

63.8 + 16 = 79.8 GB
1 1
Archive log: 198 GB 239.4 GB Multiply the estimated size of the active log by a factor of 3.
Suggested size
The following calculation was used for multiple transactions
and an 800 GB object:

50 GB x 3 = 150 GB

Increase that amount by the suggested starting size of 48 GB:

150 + 48 = 198 GB

The following calculation was used for multiple transactions

and a 4 TB object:

63.8 GB x 3 = 191.4 GB

Increase that amount by the suggested starting size of 48 GB:

191.4 + 48 = 239.4 GB

Chapter 1. Planning to install the IBM Spectrum Protect server 37

Installing the IBM Spectrum Protect server

Table 9. Average duplicate-extent size of 700 KB (continued)

Item Example values Description
1
The example values in this table are used only to illustrate how the sizes for active logs and archive logs are
calculated. In a production environment that uses deduplication, 32 GB is the suggested minimum size for an active
log. The suggested minimum size for an archive log in a production environment that uses deduplication is 96 GB.
If you substitute values from your environment and the results are larger than 32 GB and 96 GB, use your results to
size the active log and archive log.

Monitor your logs and adjust their size if necessary.

Table 10. Average duplicate-extent size of 256 KB

Item Example values Description
Size of largest single 800 GB 4 TB The granularity of processing for deduplication is at the file
object to deduplicate level. Therefore, the largest single file to deduplicate
represents the largest transaction and a correspondingly
large load on the active and archive logs.
Average size of 256 KB 256 KB The deduplication algorithms use a variable block method.
extents Not all deduplicated extents for a given file are the same
size, so this calculation assumes an average extent size.
Extents for a given 3,276,800 bits 16,777,216 Using the average extent size, these calculations represent
file bits the total number of extents for a given object.

The following calculation was used for multiple transactions

and an 800 GB object:

(800 GB ÷ 256 KB) = 3,276,800 bits

The following calculation was used for multiple transactions

and a 4 TB object:

(4 TB ÷ 256 KB) = 16,777,216 bits

Active log: Suggested 4.5 GB 23.4 GB The estimated size of the active log space that is required for
size that is required this transaction.
for the deduplication
of a single large object
during a single
duplicate-
identification process

38 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

Table 10. Average duplicate-extent size of 256 KB (continued)

Item Example values Description
1 1
Active log: Suggested 71.6 GB 109.4 GB After considering other aspects of the workload on the
total size server in addition to deduplication, multiply the existing
estimate by a factor of 2. In these examples, the active log
space required to deduplicate a single large object is
considered along with previous estimates for the required
active log size.

The following calculation was used for multiple transactions

and an 800 GB object:

(23.3 GB + 4.5 GB) x 2 = 55.6 GB

Increase that amount by the suggested starting size of 16 GB:

55.6 + 16 = 71.6 GB

The following calculation was used for multiple transactions

and a 4 TB object:

(23.3 GB + 23.4 GB) x 2 = 93.4 GB

Increase that amount by the suggested starting size of 16 GB:

93.4 + 16 = 109.4 GB
1 1
Archive log: 214.8 GB 328.2 GB The estimated size of the active log multiplied by a factor of
Suggested size 3.

The following calculation was used for an 800 GB object:

55.6 GB x 3 = 166.8 GB

Increase that amount by the suggested starting size of 48 GB:

166.8 + 48 = 214.8 GB

The following calculation was used for a 4 TB object:

93.4 GB x 3 = 280.2 GB

Increase that amount by the suggested starting size of 48 GB:

280.2 + 48 = 328.2 GB
1
The example values in this table are used only to illustrate how the sizes for active logs and archive logs are
calculated. In a production environment that uses deduplication, 32 GB is the suggested minimum size for an active
log. The suggested minimum size for an archive log in a production environment that uses deduplication is 96 GB.
If you substitute values from your environment and the results are larger than 32 GB and 96 GB, use your results to
size the active log and archive log.

Monitor your logs and adjust their size if necessary.

Chapter 1. Planning to install the IBM Spectrum Protect server 39

Installing the IBM Spectrum Protect server

Active-log mirror space

The active log can be mirrored so that the mirrored copy can be used if the active
log files cannot be read. There can be only one active log mirror.

Creating a log mirror is a suggested option. If you increase the size of the active
log, the log mirror size is increased automatically. Mirroring the log can affect
performance because of the doubled I/O activity that is required to maintain the
mirror. The additional space that the log mirror requires is another factor to
consider when deciding whether to create a log mirror.

If the mirror log directory becomes full, the server issues error messages to the
activity log and to the db2diag.log. Server activity continues.

Archive-failover log space

The archive failover log is used by the server if the archive log directory runs out
of space.

Specifying an archive failover log directory can prevent problems that occur if the
archive log runs out of space. If both the archive log directory and the drive or file
system where the archive failover log directory is located become full, the data
remains in the active log directory. This condition can cause the active log to fill
up, which causes the server to halt.

Monitoring space utilization for the database and recovery

logs
To determine the amount of used and available active log space, you issue the
QUERY LOG command. To monitor space utilization in the database and recovery
logs, you can also check the activity log for messages.

Active log

If the amount of available active log space is too low, the following messages are
displayed in the activity log:
ANR4531I: IC_AUTOBACKUP_LOG_USED_SINCE_LAST_BACKUP_TRIGGER
This message is displayed when the active log space exceeds the maximum
specified size. The IBM Spectrum Protect server starts a full database
backup.
To change the maximum log size, halt the server. Open the dsmserv.opt
file, and specify a new value for the ACTIVELOGSIZE option. When you are
finished, restart the server.
ANR0297I: IC_BACKUP_NEEDED_LOG_USED_SINCE_LAST_BACKUP
This message is displayed when the active log space exceeds the maximum
specified size. You must back up the database manually.
To change the maximum log size, halt the server. Open the dsmserv.opt
file, and specify a new value for the ACTIVELOGSIZE option. When you are
finished, restart the server.
ANR4529I: IC_AUTOBACKUP_LOG_UTILIZATION_TRIGGER
The ratio of used active-log space to available active-log space exceeds the
log utilization threshold. If at least one full database backup has occurred,
the IBM Spectrum Protect server starts an incremental database backup.
Otherwise, the server starts a full database backup.

40 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

ANR0295I: IC_BACKUP_NEEDED_LOG_UTILIZATION
The ratio of used active-log space to available active-log space exceeds the
log utilization threshold. You must back up the database manually.

Archive log

If the amount of available archive log space is too low, the following message is
displayed in the activity log:
ANR0299I: IC_BACKUP_NEEDED_ARCHLOG_USED
The ratio of used archive-log space to available archive-log space exceeds
the log utilization threshold. The IBM Spectrum Protect server starts a full
automatic database backup.

Database

If the amount of space available for database activities is too low, the following
messages are displayed in the activity log:
ANR2992W: IC_LOG_FILE_SYSTEM_UTILIZATION_WARNING_2
The used database space exceeds the threshold for database space
utilization. To increase the space for the database, use the EXTEND DBSPACE
command, the EXTEND DBSPACE command, or the DSMSERV FORMAT
utility with the DBDIR parameter.
ANR1546W: FILESYSTEM_DBPATH_LESS_1GB
The available space in the directory where the server database files are
located is less than 1 GB.
When an IBM Spectrum Protect server is created with the DSMSERV
FORMAT utility or with the configuration wizard, a server database and
recovery log are also created. In addition, files are created to hold database
information used by the database manager. The path specified in this
message indicates the location of the database information used by the
database manager. If space is unavailable in the path, the server can no
longer function.
You must add space to the file system or make space available on the file
system or disk.

Deleting installation rollback files

You can delete certain installation files that were saved during the installation
process to free space in the shared resource directory. For example, files that might
have been required for a rollback operation are types of files that you can delete.

About this task

To delete the files that are no longer needed, use either the installation graphical
wizard or the command line in console mode.

Chapter 1. Planning to install the IBM Spectrum Protect server 41

Installing the IBM Spectrum Protect server

Deleting installation rollback files by using a graphical wizard

You can delete certain installation files that were saved during installation process
by using the IBM Installation Manager user interface.

Procedure
1. Open IBM Installation Manager.
2. Click File > Preferences.
3. Select Files for Rollback.
4. Click Delete Saved Files and click OK.

Deleting installation rollback files by using the command line

You can delete certain installation files that were saved during the installation
process by using the command line.

Procedure
1. In the directory where IBM Installation Manager is installed, go to the
following subdirectory:
eclipse\tools
For example:
C:\Program Files\IBM\Installation Manager\eclipse\tools
2. From the tools directory, issue the following command to start an IBM
Installation Manager command line:
imcl.exe -c
3. Enter P to select Preferences.
4. Enter 3 to select Files for Rollback.
5. Enter D to Delete the Files for Rollback.
6. Enter A to Apply Changes and Return to Preferences Menu.
7. Enter C to leave the Preference Menu.
8. Enter X to Exit Installation Manager.

Server naming best practices

Use these descriptions as a reference when you install or upgrade an IBM
Spectrum Protect server.

Instance user ID

The instance user ID is used as the basis for other names related to the server
instance. The instance user ID is also called the instance owner.

For example: tsminst1

The instance user ID is the user ID that must have ownership or read/write access
authority to all directories that you create for the database and the recovery log.
The standard way to run the server is under the instance user ID. That user ID
must also have read/write access to the directories that are used for any FILE
device classes.

Database instance name

The database instance name is the name of the server instance as it appears
in the registry.

42 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

For example: Server1

Instance directory

The instance directory is a directory that contains files specifically for a server
instance (the server options file and other server-specific files). It can have any
name that you want. For easier identification, use a name that ties the directory to
the instance name.
You can use a name that includes the name of the server instance as it
appears (or will appear) in the registry. Default server instance names have
the form Serverx.
For example: C:\tsm\server1
The instance directory stores the following files for the server instance:
v The server options file, dsmserv.opt
v The server key database file, cert.kdb, and the .arm files (used by clients
and other servers to import the Secure Sockets Layer certificates of the
server)
v Device configuration file, if the DEVCONFIG server option does not specify
a fully qualified name
v Volume history file, if the VOLUMEHISTORY server option does not specify a
fully qualified name
v Volumes for DEVTYPE=FILE storage pools, if the directory for the
device class is not fully specified, or not fully qualified
v User exits
v Trace output (if not fully qualified)

Database name

The database name is always TSMDB1, for every server instance. This name cannot
be changed.

Server name

The server name is an internal name for IBM Spectrum Protect, and is used for
operations that involve communication among multiple IBM Spectrum Protect
servers. Examples include server-to-server communication and library sharing.

The server name is also used when you add the server to the Operations Center so
that it can be managed using that interface. Use a unique name for each server. For
easy identification in the Operations Center (or from a QUERY SERVER command),
use a name that reflects the location or purpose of the server. Do not change the
name of an IBM Spectrum Protect server after it is configured as a hub or spoke
server.

If you use the wizard, the default name that is suggested is the host name of the
system that you are using. You can use a different name that is meaningful in your
environment. If you have more than one server on the system and you use the
wizard, you can use the default name for only one of the servers. You must enter a
unique name for each server.

For example,
TUCSON_SERVER1

Chapter 1. Planning to install the IBM Spectrum Protect server 43

Installing the IBM Spectrum Protect server

TUCSON_SERVER2

Directories for database space and recovery log

The directories can be named according to local practices. For easier identification,
consider using names that tie the directories to the server instance.

For example, for the archive log:

f:\server1\archlog

Installation directories
Installation directories for the IBM Spectrum Protect server include the server, DB2,
device, language, and other directories. Each one contains several additional
directories.

The (/opt/tivoli/tsm/server/bin) is the default directory that contains server

code and licensing.

The DB2 product that is installed as part of the installation of the IBM Spectrum
Protect server has the directory structure as documented in DB2 information
sources. Protect these directories and files as you do the server directories. The
default directory is /opt/tivoli/tsm/db2.

You can use US English, German, French, Italian, Spanish, Brazilian Portuguese,
Korean, Japanese, traditional Chinese, simplified Chinese, Chinese GBK, Chinese
Big5, and Russian.

44 IBM Spectrum Protect for Windows: Installation Guide

Chapter 2. Installing the server components
To install the Version 8.1.2 server components, you can use the installation wizard,
the command line in console mode, or silent mode.

About this task

Using the IBM Spectrum Protect installation software, you can install the following
components:
v server

Tip: The database (DB2), the Global Security Kit (GSKit) and IBM Java Runtime
Environment (JRE) are automatically installed when you select the server
component.
v server languages
v license
v devices
v IBM Spectrum Protect for SAN
v Operations Center

Allow approximately 15 - 30 minutes to install a V8.1.2 server, using this guide.

Obtaining the installation package

You can obtain the IBM Spectrum Protect installation package from an IBM
download site such as Passport Advantage® or IBM Fix Central.

Procedure
1. Download the appropriate package file from one of the following websites.
v Download the server package from Passport Advantage or Fix Central.
v For the latest information, updates, and maintenance fixes, go to the IBM
Support Portal.
2. If you downloaded the package from an IBM download site, complete the
following steps:
a. Verify that you have enough space to store the installation files when they
are extracted from the product package. See the download document for the
space requirements:
v IBM Spectrum Protect technote 4042944
v IBM Spectrum Protect Extended Edition technote 4042945
v IBM Spectrum Protect for Data Retention technote 4042946
b. Change to the directory where you placed the executable file.

Important: In the next step, the files are extracted to the current directory.
The path must contain no more than 128 characters. Be sure to extract the
installation files to an empty directory. Do not extract to a directory that
contains previously extracted files, or any other files.
c. Either double-click the executable file, or enter the following command on
the command line to extract the installation files. The files are extracted to
the current directory.

© Copyright IBM Corp. 1993, 2017 45

 Installing the IBM Spectrum Protect server

package_name.exe
| where package_name is like this example: 8.1.x.000-IBM-SPSRV-
| WindowsX64.exe
3. Select one of the following methods of installing IBM Spectrum Protect:
v “Installing IBM Spectrum Protect by using the installation wizard”
v “Installing IBM Spectrum Protect by using console mode” on page 47
v “Installing IBM Spectrum Protect in silent mode” on page 48
4. After you install IBM Spectrum Protect, and before you customize it for your
use, go to the IBM Support Portal. Click Support and downloads and apply
any applicable fixes.

Installing IBM Spectrum Protect by using the installation wizard

You can install the server by using the IBM Installation Manager graphical wizard.

Before you begin

Take the following actions before you start the installation:

v Verify that the operating system is set to the language that you require. By
default, the language of the operating system is the language of the installation
wizard.
v Ensure that the user ID that you plan to use during the installation is a user
with local Administrator authority.

Procedure

Install IBM Spectrum Protect by using this method:

Option Description
Installing the software from a downloaded 1. Change to the directory where you
package: downloaded the package.
2. Start the installation wizard by issuing
the following command:
install.bat
Or, in the directory where the installation
files were extracted, double-click the
install.bat file.

What to do next
v If errors occur during the installation process, the errors are recorded in log files
that are stored in the IBM Installation Manager logs directory.
You can view installation log files by clicking File > View Log from the
Installation Manager tool. To collect these log files, click Help > Export Data for
Problem Analysis from the Installation Manager tool.
v After you install the server and components, and before you customize it for
your use, go to the IBM Support Portal. Click Downloads (fixes and PTFs) and
apply any applicable fixes.
v After you install a new server, review Taking the first steps after you install IBM
Spectrum Protect to learn about configuring your server.
v If a native device driver is available on Windows for the tape drives or medium
changers that you plan to use, use the native device driver. If a native device

46 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

driver is not available on Windows for the tape drives or medium changers that
you plan to use, install the IBM Spectrum Protect device driver by issuing the
dpinst.exe /a command. The dpinst.exe file is in the device driver directory.
The default directory is C:\Program Files\Tivoli\TSM\device\drivers.

Installing IBM Spectrum Protect by using console mode

You can install IBM Spectrum Protect by using the command line in console mode.

Before you begin

Take the following actions before you start the installation:

v Verify that the operating system is set to the language that you require. By
default, the language of the operating system is the language of the installation
wizard.
v Ensure that the user ID that you plan to use during the installation is a user
with local Administrator authority.

Procedure

Install IBM Spectrum Protect by using this method:

Option Description
Installing the software from a downloaded 1. Change to the directory where you
package: downloaded the package.
2. Start the installation wizard in console
mode by issuing the following
command:
install.bat -c

Optional: Generate a response file as

part of a console mode installation.
Complete the console mode installation
options, and in the Summary panel,
specify G to generate the responses.

What to do next
v If errors occur during the installation process, the errors are recorded in log files
that are stored in the IBM Installation Manager logs directory, for example:
C:\ProgramData\IBM\Installation Manager\logs
v After you install the server and components, and before you customize it for
your use, go to the IBM Support Portal. Click Downloads (fixes and PTFs) and
apply any applicable fixes.
v After you install a new server, review Taking the first steps after you install IBM
Spectrum Protect to learn about configuring your server.
v If a native device driver is available on Windows for the tape drives or medium
changers that you plan to use, use the native device driver. If a native device
driver is not available on Windows for the tape drives or medium changers that
you plan to use, install the IBM Spectrum Protect device driver by issuing the
dpinst.exe /a command. The dpinst.exe file is in the device driver directory.
The default directory is C:\Program Files\Tivoli\TSM\device\drivers.

Chapter 2. Installing the server components 47

Installing the IBM Spectrum Protect server

Installing IBM Spectrum Protect in silent mode

You can install or upgrade the server in silent mode. In silent mode, the
installation does not send messages to a console but instead stores messages and
errors in log files.

Before you begin

To provide data input when you use the silent installation method, you can use a
response file. The following sample response files are provided in the input
directory where the installation package is extracted:
install_response_sample.xml
Use this file to install the IBM Spectrum Protect components.
update_response_sample.xml
Use this file to upgrade the IBM Spectrum Protect components.

These files contain default values that can help you avoid any unnecessary
warnings. To use these files, follow the instructions that are provided in the files.

If you want to customize a response file, you can modify the options that are in
the file. For information about response files, see Response files.

Procedure
1. Create a response file. You can modify the sample response file or create your
own file.
2. If you install the server and Operations Center in silent mode, create a
password for the Operations Center truststore in the response file.
If you are using the install_response_sample.xml file, add the password in the
following line of the file, where mypassword represents the password:
<variable name=’ssl.password’ value=’mypassword’ />

For more information about this password, see Installation checklist

Tip: To upgrade the Operations Center, the truststore password is not required
if you are using the update_response_sample.xml file.
3. Start the silent installation by issuing the following command from the
directory where the installation package is extracted. The value response_file
represents the response file path and file name:
v install.bat -s -input response_file -acceptLicense

What to do next
v If errors occur during the installation process, the errors are recorded in log files
that are stored in the IBM Installation Manager logs directory, for example:
C:\ProgramData\IBM\Installation Manager\logs
v After you install the server and components, and before you customize it for
your use, go to the IBM Support Portal. Click Downloads (fixes and PTFs) and
apply any applicable fixes.
v After you install a new server, review Taking the first steps after you install IBM
Spectrum Protect to learn about configuring your server.
v If a native device driver is available on Windows for the tape drives or medium
changers that you plan to use, use the native device driver. If a native device
driver is not available on Windows for the tape drives or medium changers that

48 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

you plan to use, install the IBM Spectrum Protect device driver by issuing the
dpinst.exe /a command. The dpinst.exe file is in the device driver directory.
The default directory is C:\Program Files\Tivoli\TSM\device\drivers.

Installing server language packages

Translations for the server allow the server to display messages and help in
languages other than US English. The translations also allow for the use of locale
conventions for date, time, and number formatting.

Before you begin

For instructions on installing storage agent language packages, see Language pack
configuration for storage agents.

Server language locales

Use either the default language package option or select another language package
to display server messages and help.

This language package is automatically installed for the following default language
option for server messages and help: LANGUAGE AMENG.

For languages or locales other than the default, install the language package that
your installation requires.

You can use the languages that are shown:

Table 11. Server languages for Windows
Language LANGUAGE option value
Chinese, Simplified chs
Chinese, Traditional cht
English ameng
French fra
German deu
Italian ita
Japanese (Shift-JIS) jpn
Korean kor
Portuguese, Brazilian ptb
Russian rus
Spanish esp

Restriction: For Operations Center users, some characters might not be displayed
properly if the web browser does not use the same language as the server. If this
problem occurs, set the browser to use the same language as the server.

Chapter 2. Installing the server components 49

Installing the IBM Spectrum Protect server

Configuring a language package

After you configure a language package, messages and help are shown on the
server in languages other than US English. Installation packages are provided with
IBM Spectrum Protect.

About this task

Set the LANGUAGE option in the server options file to the name of the locale that you
want to use. For example: to use the ita locale, set the LANGUAGE option to ita. See
“Server language locales” on page 49.

If the locale is successfully initialized, it formats the date, time, and number for the
server. If the locale is not successfully initialized, the server uses the US English
message files and the date, time, and number format.

Updating a language package

You can modify or update a language package by using the IBM Installation
Manager.

About this task

You can install another language package within the same IBM Spectrum Protect
instance.
v Use the Modify function of IBM Installation Manager to install another language
package.
v Use the Update function of IBM Installation Manager to update to newer
versions of the language packages.

Tip: In IBM Installation Manager, the term update means to discover and install
updates and fixes to installed software packages. In this context, update and upgrade
are synonymous.

50 IBM Spectrum Protect for Windows: Installation Guide

Chapter 3. Taking the first steps after you install IBM
Spectrum Protect
After you install Version 8.1.2, prepare for the configuration. Using the
configuration wizard is the preferred method of configuring the IBM Spectrum
Protect instance.

About this task

1. Create the directories and user ID for the server instance. See “Creating the
user ID and directories for the server instance.”
2. Configure a server instance. Select one of the following options:
v Use the configuration wizard, the preferred method. See “Configuring IBM
Spectrum Protect by using the configuration wizard” on page 54.
v Manually configure the new instance. See “Configuring the server instance
manually” on page 55. Complete the following steps during a manual
configuration.
a. Set up your directories and create the IBM Spectrum Protect instance. See
“Creating the server instance” on page 56.
b. Create a new server options file by copying the sample file to set up
communications between the server and clients. See “Configuring server
and client communications” on page 57.
c. Issue the DSMSERV FORMAT command to format the database. See
“Formatting the database and log” on page 60.
d. Configure your system for database backup. See “Preparing the database
manager for database backup” on page 61.
3. Configure options to control when database reorganization runs. See
“Configuring server options for server database maintenance” on page 62.
4. Start the server instance if it is not already started.
See “Starting the server instance on Windows systems” on page 63.
5. Register your license. See “Registering licenses” on page 68.
6. Prepare your system for database backups. See “Specifying a device class in
preparation for database backups” on page 68.
7. Monitor the server. See “Monitoring the server” on page 70.

Creating the user ID and directories for the server instance

Create the user ID for the IBM Spectrum Protect server instance and create the
directories that the server instance needs for database and recovery logs.

Before you begin

Review the information about planning space for the server before you complete
this task. See “Worksheets for planning details for the server” on page 23.

Procedure
1. Create the user ID that will own the server instance. You use this user ID when
you create the server instance in a later step.
Create a user ID that will be the owner of the IBM Spectrum Protect

© Copyright IBM Corp. 1993, 2017 51

Installing the IBM Spectrum Protect server

server instance. A user ID can own more than one IBM Spectrum
Protect server instance. Identify the user account that will own the
server instance.
When the server is started as a Windows service, this account is the
one that the service will log on to. The user account must have
administrative authority on the system. One user account can own
more than one server instance.
If you have multiple servers on one system and want to run each
server with a different user account, create a new user account in this
step.
Create the user ID.

Restriction: The user ID must comply with the following rule:

In the user ID, only lowercase letters (a-z), numerals (0-9), and the
underscore character ( _ ) can be used. The user ID must be 30
characters or less, and cannot start with ibm, sql, sys, or a numeral. The
user ID and group name cannot be user, admin, guest, public, local, or
any SQL reserved word.
a. Use the following operating system command to create the user ID:
net user user_ID * /add

You are prompted to create and verify a password for the new user
ID.
b. Issue the following operating system commands to add the new
user ID to the Administrators groups:
net localgroup Administrators user_ID /add
net localgroup DB2ADMNS user_ID /add
2. Create directories that the server requires.
Create empty directories for each item in the table and ensure that the new user ID you just
created has read/write permission to the directories. The database, archive log, and active
log must reside on different physical volumes.
Example commands for
Item creating the directories Your directories
The instance directory for mkdir d:\tsm\server1
the server, which is a
directory that will
contain files specifically
for this server instance
(the server options file
and other server-specific
files)
The database directories mkdir d:\tsm\db001
mkdir e:\tsm\db002
mkdir f:\tsm\db003
mkdir g:\tsm\db004
Active log directory mkdir h:\tsm\log
Archive log directory mkdir i:\tsm\archlog
Optional: Directory for mkdir j:\tsm\logmirror
the log mirror for the
active log

52 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

Create empty directories for each item in the table and ensure that the new user ID you just
created has read/write permission to the directories. The database, archive log, and active
log must reside on different physical volumes.
Example commands for
Item creating the directories Your directories
Optional: Secondary mkdir k:\tsm\archlogfailover
archive log directory
(failover location for
archive log)

When a server is initially created by using the DSMSERV FORMAT utility or the
configuration wizard, a server database and recovery log are created. In
addition, files are created to hold database information that is used by the
database manager.
3. Log off the new user ID.

Configuring the IBM Spectrum Protect server

After you have installed the server and prepared for the configuration, configure
the server instance.

About this task

Tip: The IBM Spectrum Protect Management Console, which is a Microsoft

Management Console (MMC) snap-in, is no longer delivered with IBM Spectrum
Protect. The preferred method for configuring the server is to use the configuration
wizard. You can use the wizard to complete several server configuration tasks.
However, you cannot use the wizard to extend the Active Directory schema so that
clients can automatically discover servers.

Configure an IBM Spectrum Protect server instance by selecting one of the

following options:
v Use the IBM Spectrum Protect configuration wizard on your local system. See
“Configuring IBM Spectrum Protect by using the configuration wizard” on page
54.
v Manually configure the new IBM Spectrum Protect instance. See “Configuring
the server instance manually” on page 55. Complete the following steps during
a manual configuration.
1. Set up the directories and create the IBM Spectrum Protect instance. See
“Creating the server instance” on page 56.
2. Create a new server options file by copying the sample file in order to set up
communications between the IBM Spectrum Protect server and clients. See
“Configuring server and client communications” on page 57.
3. Issue the DSMSERV FORMAT command to format the database. See
“Formatting the database and log” on page 60.
4. Configure your system for database backup. See “Preparing the database
manager for database backup” on page 61.

Chapter 3. Taking the first steps after you install Version 8.1.2 53
Installing the IBM Spectrum Protect server

Configuring IBM Spectrum Protect by using the configuration

wizard
The wizard offers a guided approach to configuring a server. By using the
graphical user interface (GUI), you can avoid some configuration steps that are
complex when done manually. Start the wizard on the system where you installed
the IBM Spectrum Protect server program.

Before you begin

Before you begin to use the configuration wizard, you must complete all preceding
steps to prepare for the configuration. These steps include installing IBM Spectrum
Protect, creating the database and log directories, and creating the directories and
user ID for the server instance.

About this task

Tip: The IBM Spectrum Protect Console, which is an MMC snap-in, is no longer
delivered with IBM Spectrum Protect. The preferred method for configuring the
server instance is to use the configuration wizard. You can use the wizard to
complete several configuration tasks.

Procedure
1. Ensure that the following requirements are met:
v Ensure that the following requirements are met:
a. Click Start > Administrative Tools > Services.
b. In the Services window, select the Remote Registry service if it is not
started, and click Start.
v Ensure ports 137, 139 and 445 are not blocked by a firewall:
a. Click Start > Control Panel > Windows Firewall.
b. Select Advanced Settings.
c. Select Inbound Rules in the left pane.
d. Select New Rule in the right pane.
e. Create a port rule for TCP ports 137, 139 and 445 to allow connections for
domain and private networks.
v Configure User Account Control:
Access all three of the user account control configuration settings by first
accessing Local Security Policy Security options, by using the following
steps:
a. Enable the built-in Administrator account:
– Select the Accounts: Administrator account status.
– Select Enable and click OK.
b. Disable User Account Control for all Windows administrators:
– Select the User Account Control: Run all administrators in Admin
Approval Mode.
– Select Disable and click OK.
c. Disable User Account Controll for the built-in Administrator account:
– Select the User Account Control: Admin Approval Mode for the
Built-in Administrator Account.
– Select Disable and click OK.
v Restart the server before you proceed with the Configuration wizard.

54 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

2. Start the local version of the wizard:

Either click Start > All Programs > IBM Spectrum Protect > Configuration
Wizard. Or, double-click the dsmicfgx.exe program in
installation_directory\server. The default directory is C:\Program
Files\Tivoli\TSM.
Follow the instructions to complete the configuration. The wizard can be
stopped and restarted, but the server is not operational until the entire
configuration process is complete.

Configuring Remote Execution Protocol on Windows

Configure remote access settings by using these procedures.

Before you begin

You must configure the User Account Control feature before you run the wizard.

Tip: Ensure that the Remote Registry in Windows Services is started, and ports
445, 137, and 139 are unblocked in the firewall.

Procedure

If the system is running on Windows, complete the following steps to disable User
Account Control:
1. The built-in Administrator account must be enabled. To enable the built-in
administrator account, click Control Panel > Administrative Tools > Local
Security Policy. Then, under Security Settings, double-click Local Policies.
Double-click Security Options. Double-click the Accounts: Administrator
account status section. Select Enable and click OK.
2. User Account Control must be disabled for all windows administrators. To
disable User Account Control for administrators, click Control Panel >
Administrative Tools > Local Security Policy. Then, under Security Settings,
double-click Local Policies. Double-click Security Options. Double-click the
User Account Control: Run all administrators in Admin Approval Mode
section. Select Disable and click OK.
3. User Account Control must be disabled for the built-in Administrator account.
To disable User Account Control for administrators, click Control Panel >
Administrative Tools > Local Security Policy. Then, under Security Settings,
double-click Local Policies. Double-click Security Options. Double-click the
User Account Control: Admin Appoval Mode for the Built-in Administrator
Account section. Select Disable and click OK.

Configuring the server instance manually

After installing IBM Spectrum Protect Version 8.1.2, you can configure IBM
Spectrum Protect manually instead of using the configuration wizard.

Chapter 3. Taking the first steps after you install Version 8.1.2 55
Installing the IBM Spectrum Protect server

Creating the server instance

Create an IBM Spectrum Protect instance by issuing the db2icrt command.

About this task

You can have one or more server instances on one workstation.

Important: Before you run the db2icrt command, ensure that the user and the
instance directory of the user exists. If there is no instance directory, you must
create it.

The instance directory stores the following files for the server instance:
v The server options file, dsmserv.opt
v The server key database file, cert.kdb, and the .arm files (used by clients and
other servers to import the Secure Sockets Layer certificates of the server)
v Device configuration file, if the DEVCONFIG server option does not specify a fully
qualified name
v Volume history file, if the VOLUMEHISTORY server option does not specify a fully
qualified name
v Volumes for DEVTYPE=FILE storage pools, if the directory for the device class
is not fully specified, or not fully qualified
v User exits
v Trace output (if not fully qualified)
1. Log in as an administrator and create an IBM Spectrum Protect instance, by
using the db2icrt command. Enter the following command on one line. The
user account that you specify becomes the user ID that owns the Version 8.1.2
server (the instance user ID).
db2icrt -u user_account instance_name

For example, if the user account is tsminst1 and the server instance is Server1,
enter the following command:
db2icrt -u tsminst1 server1

You are prompted for the password for user ID tsminst1. Later, when you create
and format the database, you use the instance name that you specified with
this command, with the -k option.
2. Change the default path for the database to be the drive where the instance
directory for the server is located. Complete the following steps:
a. Click Start > Programs > IBM DB2 > DB2TSM1 > Command Line Tools >
Command Line Processor.
b. Enter quit to exit the command line processor.
A window with a command prompt should now be open, with the
environment properly set up to successfully issue the commands in the next
steps.
c. From the command prompt in that window, issue the following command
to set the environment variable for the server instance that you are working
with:
set db2instance=instance_name

The instance_name is the same as the instance name that you specified when
you issued the db2icrt command. For example, to set the environment
variable for the Server1 server instance, issue the following command:

56 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

set db2instance=server1
d. Issue the command to set the default drive:
db2 update dbm cfg using dftdbpath instance_location

For example, the instance directory is d:\tsm\server1 and the instance

location is drive d:. Enter the command:
db2 update dbm cfg using dftdbpath d:
3. Create a new server options file. See “Configuring server and client
communications.”

Configuring server and client communications

After installing the server, you can set up client and server communications by
specifying options in the server and client options files.

About this task

Set these server options before you start the server. When you start the server, the
new options go into effect. If you modify any server options after starting the
server, you must stop and restart the server to activate the updated options.

Review the server options file (dsmserv.opt.smp) that is located in the server
instance directory to view and specify server communications options. By default,
the server uses the TCP/IP and Named Pipes communication methods.

Tip: If you start the server console and see warning messages that a protocol could
not be used by the server, either the protocol is not installed or the settings do not
match the Windows protocol settings.

For a client to use a protocol that is enabled on the server, the client options file
must contain corresponding values for communication options. In the server
options file, you can view the values for each protocol.

You can specify one or more of the following communication methods:

v TCP/IP Version 4 or Version 6
v Named Pipes
v Shared memory
v Secure Sockets Layer (SSL)

Tip: You can authenticate passwords with the LDAP directory server, or
authenticate passwords with the server. Passwords that are authenticated with
the LDAP directory server can provide enhanced system security.

Setting TCP/IP options:

Select from a range of TCP/IP options for the IBM Spectrum Protect server or
retain the default.

About this task

The following is an example of a list of TCP/IP options that you can use to set up
your system.

Chapter 3. Taking the first steps after you install Version 8.1.2 57
 Installing the IBM Spectrum Protect server

commmethod tcpip
tcpport 1500
tcpwindowsize 0
tcpnodelay yes

Tip: You can use TCP/IP Version 4, Version 6, or both.

TCPPORT
| The server port address for TCP/IP and SSL communication. The default
| value is 1500.
TCPWINDOWSIZE
Specifies the size of the TCP/IP buffer that is used when sending or
receiving data. The window size that is used in a session is the smaller of
the server and client window sizes. Larger window sizes use additional
memory but can improve performance.
To use the default window size for the operating system, specify 0.
TCPNODELAY
Specifies whether or not the server sends small messages or lets TCP/IP
buffer the messages. Sending small messages can improve throughput but
increases the number of packets sent over the network. Specify YES to
send small messages or NO to let TCP/IP buffer them. The default is YES.
TCPADMINPORT
| Specifies the port number on which the server TCP/IP communication
| driver is to wait for TCP/IP or SSL-enabled communication requests other
| than client sessions. The default is the value of TCPPORT.
SSLTCPPORT
(SSL-only) Specifies the Secure Sockets Layer (SSL) port number on which
the server TCP/IP communication driver waits for requests for
SSL-enabled sessions for the command-line backup-archive client and the
command-line administrative client.
SSLTCPADMINPORT
(SSL-only) Specifies the port address on which the server TCP/IP
communication driver waits for requests for SSL-enabled sessions for the
command-line administrative client.

Setting Named Pipes options:

The Named Pipes communication method is ideal when running the server and
client on the same Windows machine. Named Pipes require no special
configuration.

About this task

Here is an example of a Named Pipes setting:

commmethod namedpipe
namedpipename \\.\pipe\adsmpipe

COMMMETHOD can be used multiple times in the IBM Spectrum Protect server options
file, with a different value each time. For example, the following example is
possible:

58 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

commmethod tcpip
commmethod namedpipe

Setting Secure Sockets Layer options:

You can add more protection for your data and passwords by using Secure Sockets
Layer (SSL).

Before you begin

SSL is the standard technology for creating encrypted sessions between servers and
clients. SSL provides a secure channel for servers and clients to communicate over
open communication paths. With SSL, the identity of the server is verified through
the use of digital certificates.

To ensure better system performance, use SSL only for sessions when it is needed.
Consider adding additional processor resources on the IBM Spectrum Protect
server to manage the increased requirements.

Chapter 3. Taking the first steps after you install Version 8.1.2 59
Installing the IBM Spectrum Protect server

Formatting the database and log

Use the DSMSERV FORMAT utility to initialize a server instance. No other server
activity is allowed while you initialize the database and recovery log.

After you set up server communications, you are ready to initialize the database.
Ensure that you log in by using the instance user ID. Do not place the directories
on file systems that might run out of space. If certain directories (for example, the
archive log) become unavailable or full, the server stops. See Capacity planning for
more details.

For optimal performance and to facilitate I/O, specify at least two equally sized
containers or Logical Unit Numbers (LUNs) for the database. In addition, each
active log and archive log needs its own container or LUN.

Important: The installation program creates a set of registry keys. One of these
keys points to the directory where a default server, named SERVER1, is created. To
install an additional server, create a directory and use the DSMSERV FORMAT utility,
with the -k parameter, from that directory. That directory becomes the location of
the server. The registry tracks the installed servers.

Setting the exit list handler

Set the DB2NOEXITLIST registry variable to ON for each server instance. Log on to the
system as the server instance owner and issue this command:
db2set -i server_instance_name DB2NOEXITLIST=ON

For example:
db2set -i server1 DB2NOEXITLIST=ON

Initializing a server instance

Use the DSMSERV FORMAT utility to initialize a server instance. For example, if the
server instance directory is /tsminst1, issue the following commands:
cd \tsminst1
dsmserv -k server2 format dbdir=d:\tsm\db001 activelogsize=32768
activelogdirectory=e:\tsm\activelog archlogdirectory=f:\tsm\archlog
archfailoverlogdirectory=g:\tsm\archfaillog mirrorlogdirectory=h:\tsm\mirrorlog

Tip: If you specify multiple directories, ensure that the underlying file systems are
of equal size to ensure a consistent degree of parallelism for database operations. If
one or more directories for the database are smaller than the others, they reduce
the potential for optimized parallel prefetching and distribution of the database.
Related information:
DSMSERV FORMAT (Format the database and log)

60 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

Preparing the database manager for database backup

To back up the data in the database to IBM Spectrum Protect, you must enable the
database manager and configure the IBM Spectrum Protect application
programming interface (API).

About this task

If you use the configuration wizard to create an IBM Spectrum Protect server
instance, you do not have to complete these steps. If you are configuring an
instance manually, complete the following steps before you issue either the BACKUP
DB or the RESTORE DB commands.

Attention: If the database is unusable, the entire IBM Spectrum Protect server is
unavailable. If a database is lost and cannot be recovered, it might be difficult or
impossible to recover data that is managed by that server. Therefore, it is critically
important to back up the database.

Restriction: Database backup and restore over shared memory are not available on
Windows systems.

In the following commands, the examples use server1 for the database instance
and d:\tsmserver1 for the IBM Spectrum Protect server directory. Replace these
values with your actual values in the commands.
1. Create a file that is called tsmdbmgr.env in the d:\tsmserver1 directory with the
following contents:
DSMI_CONFIG=server_instance_directory\tsmdbmgr.opt
DSMI_LOG=server_instance_directory
2. Set the DSMI_ api environment-variable configuration for the database instance:
a. Open a DB2 command window. One method is to go to the C:\Program
Files\Tivoli\TSM\db2\bin directory, or if you installed IBM Spectrum
Protect in a different location, go to the db2\bin subdirectory in your main
installation directory. Then, issue this command:
db2cmd
b. Issue this command:
db2set -i server1 DB2_VENDOR_INI=d:\tsmserver1\tsmdbmgr.env
3. Create a file that is called tsmdbmgr.opt in the d:\tsmserver1 directory with the
following contents:
*************************************************
nodename $$_TSMDBMGR_$$
commmethod tcpip
tcpserveraddr localhost
tcpport 1500
passwordaccess generate
errorlogname d:\tsmserver1\tsmdbmgr.log
where
v nodename specifies the node name the client API uses to connect to the server
during a database backup. This value must be $$_TSMDBMGR_$$ for database
backup to work.
v commethod specifies the client API used to contact the server for database
backup.
v tcpserveraddr specifies the server address that the client API uses to contact
the server for database backup. To ensure that the database can be backed
up, this value must be localhost.

Chapter 3. Taking the first steps after you install Version 8.1.2 61
Installing the IBM Spectrum Protect server

v tcpport specifies the port number that the client API uses to contact the server
for database backup. Ensure that you enter the same tcpport value that is
specified in the dsmserv.opt server options file.
v passwordaccess is required for the backup node to connect to the server on
windows systems.
v errorlogname specifies the error log where the client API logs errors that are
encountered during a database backup. This log is typically in the server
instance directory. However, this log can be placed in any location where the
instance user ID has write-permission.

Configuring server options for server database maintenance

To help avoid problems with database growth and server performance, the server
automatically monitors its database tables and reorganizes them when needed.
Before starting the server for production use, set server options to control when
reorganization runs. If you plan to use data deduplication, ensure that the option
to run index reorganization is enabled.

About this task

Table and index reorganization requires significant processor resources, active log
space, and archive log space. Because database backup takes precedence over
reorganization, select the time and duration for reorganization to ensure that the
processes do not overlap and reorganization can complete.

You can optimize index and table reorganization for the server database. In this
way, you can help to avoid unexpected database growth and performance issues.
For instructions, see technote 1683633.

If you update these server options while the server is running, you must stop and
restart the server before the updated values take effect.

Procedure
1. Modify the server options.
Edit the server options file, dsmserv.opt, in the server instance directory by
using a text editor. Follow these guidelines when you edit the server options
file:
v To enable an option, remove the asterisk at the beginning of the line.
v Enter an option on any line.
v Enter only one option per line. The entire option with its value must be on
one line.
v If you have multiple entries for an option in the file, the server uses the last
entry.
To view available server options, see the sample file, dsmserv.opt.smp, in the
c:\Program Files\Tivoli\TSM directory.
2. If you plan to use data deduplication, enable the ALLOWREORGINDEX server
option. Add the following option and value to the server options file:
allowreorgindex yes
3. Set the REORGBEGINTIME and REORGDURATION server options to control when
reorganization starts and how long it runs. Select a time and duration so that
reorganization runs when you expect that the server is least busy. These server
options control both table and index reorganization processes.

62 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

a. Set the time for reorganization to start by using the REORGBEGINTIME server
option. Specify the time by using the 24-hour system. For example, to set
the start time for reorganization as 8:30 p.m., specify the following option
and value in the server options file:
reorgbegintime 20:30
b. Set the interval during which the server can start reorganization. For
example, to specify that the server can start reorganization for four hours
after the time set by the REORGBEGINTIME server option, specify the following
option and value in the server options file:
reorgduration 4
4. If the server was running while you updated the server options file, stop and
restart the server.
Related information:
ALLOWREORGINDEX
ALLOWREORGTABLE
REORGBEGINTIME
REORGDURATION

Starting the server instance on Windows systems

In a production environment, the preferred method for starting the server is as a
Windows service. In an environment where you are reconfiguring, testing, or
completing maintenance tasks, start the server in the foreground or use
maintenance mode.

Before you begin

Select one of the following methods for starting the server:

As a Windows service
This method is useful in a production environment. When you configure
the server to run as a service, you can specify that the server starts
automatically whenever the system is started.
In the foreground
This method is useful when you are configuring or testing the server.
When you start the server in the foreground, IBM Spectrum Protect
provides a special administrator user ID that is named
SERVER_CONSOLE. All server messages are displayed in the foreground.
The messages can be useful if you must debug startup problems.
In maintenance mode
This method is useful when you are completing maintenance or
reconfiguration tasks. When you start the server in maintenance mode, you
disable operations that might disrupt your maintenance or reconfiguration
tasks.

Chapter 3. Taking the first steps after you install Version 8.1.2 63
Installing the IBM Spectrum Protect server

Procedure

Follow the instructions for your selected option:

Option Description
Starting the server as a Windows service
To start the server as a Windows service,
take one of the following actions:
v If you configured the server by using the
configuration wizard, complete the
following steps:
1. Configure the server to start as a
Windows service by following the
instructions in “Configuring the server
to start as a Windows service.”
2. Start the server by following the
instructions in “Starting the server as a
Windows service” on page 65.
v If you did not use the configuration
wizard, create and configure the Windows
service by following the instructions in
“Manually creating and configuring a
Windows service” on page 66.
Starting the server in the foreground To start the server in the foreground, follow
the instructions in “Starting the server in the
foreground” on page 67.
Starting the server in maintenance mode To start the server in maintenance mode,
follow the instructions in “Starting the
server in maintenance mode” on page 67.

Configuring the server to start as a Windows service

Before you can start the server as a Windows service, you must ensure that options
and access rights are set correctly.

Before you begin

A Windows service must be created. If you configured the server by using the
configuration wizard, a Windows service was created automatically. In that case,
use this procedure to configure the server to start as a Windows service.

If you did not use a wizard, you must create and configure the Windows service
manually by following the steps in “Manually creating and configuring a Windows
service” on page 66.

Procedure
1. From the Windows Start menu, click Run, type services.msc, and click OK.
2. In the Services window, select the server instance that you want to start as a
service, and click Properties. For example, select TSM INST1, and click
Properties.
3. To ensure that the server service starts automatically, click the General tab.
From the Startup type list, select Automatic.
4. To set the user for starting the server service, click the Log On tab, and take
one of the following actions:

64 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

v If you plan to run the server service under the Local System account, select
Local System account and click OK.
v If you plan to run the server service under the instance user ID, take the
following actions:
a. Select This account, and browse for the user ID that owns the server DB2
instance and has permissions for starting the server.
b. In the Select User window, in the Enter the object name to select field,
enter the user ID.
c. Click Check Names.
d. Click OK twice.
5. If you configured the server service to run under the Local System account,
grant database access to the Local System account:
a. Log on with the user ID that was used to create the server database. This
user ID is the user ID that was used to run the DSMSERV FORMAT utility to
initialize the server database. Alternatively, if you configured the server
with the dsmicfgx configuration wizard, this user ID is the user ID that was
used to create the instance.
| b. Open a DB2 command window. If the server is installed on Windows Server
| 2012, open the Start window, and click DB2 Command Window -
| Administrator.
c. In the DB2 command window, enter the following commands:
set DB2INSTANCE=server1
db2 connect to TSMDB1
db2 grant dbadm with dataaccess with accessctrl on database to user system
db2 grant secadm on database to user system

Tip: When the server service is configured to run under the Local System
account, the database can be accessed by any administrator on the system.
In addition, any administrator who can log on to the system can run the
server.

What to do next

To start the service, follow the instructions in “Starting the server as a Windows
service.”

Starting the server as a Windows service

If you are running IBM Spectrum Protect on a Windows operating system, you can
start the server as a service.

Before you begin

A Windows service must be created. The service was created automatically if you
configured the server by using the configuration wizard. If the service was created
automatically, you must configure the server to start as a service by following the
steps in “Configuring the server to start as a Windows service” on page 64. Then,
use this procedure to start the server as a service.

If you did not use the configuration wizard to create the service, you must create
and configure the service manually. Follow the steps in “Manually creating and
configuring a Windows service” on page 66.

Chapter 3. Taking the first steps after you install Version 8.1.2 65
Installing the IBM Spectrum Protect server

Procedure

To start the server as a Windows service, complete the following steps:

1. Log on to the server with a user ID that is in the Administrators group.
2. From the Windows Start menu, click Run, type services.msc, and click OK.
3. In the Services window, select the server instance that you want to start, and
click Start.

What to do next

Because the server service can issue requests that require action, it is important to
monitor server activity with the Operations Center or the administrative client.

To view start and stop completion messages that are logged in the Windows
application log, use the Event Viewer tool in the Administrative Tools folder.

Manually creating and configuring a Windows service

If you configured the server by using the configuration wizard, a Windows service
was created automatically. If a service was not created automatically, you must
create it.

Before you begin

To complete this procedure, you must log on with a user ID that is in the
Administrators group.

Procedure

To create a Windows service and configure the startup options for the service,
complete the following step:

Open a command window and enter the sc.exe create command:

sc.exe create server_name binPath= "path_to_server -k instance_name"
start= start_type obj= account_name password= password

where:
server_name
Specifies the name of the server service.
path_to_server
Specifies the path to the dsmsvc.exe executable file, including the file
name. This path is the default path:
C:\Program Files\Tivoli\TSM\server
instance_name
Specifies the name of the DB2 instance, which is also the name of the
server instance, for example, Server1.
start_type
Specifies the method for starting the service. To automatically start the
service, enter auto. If you specify the auto option, the service starts
automatically at system startup and restarts automatically whenever the
system is restarted. To manually start the service, enter demand.
account_name
Specifies the user ID for the account under which the service runs. For

66 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

example, the account name might be Administrator. This parameter is

optional. If it is not specified, the Local System account is used.
password
Specifies the password for the account_name user account.

Tip: When you enter the command, ensure that you enter a space after each equal
sign (=).

Results

The server starts as a Windows service.

Starting the server in the foreground

To directly interact with an IBM Spectrum Protect server, start the server in the
foreground. For example, if you want to enter commands, start the server in the
foreground.

Procedure
1. Change to the directory where the server is installed. For example, change to
the c:\program files\tivoli\tsm\server directory.
2. Enter the following command:
dsmserv -k instance_name

where instance_name specifies the server instance.

Starting the server in maintenance mode

You can start the server in maintenance mode to avoid disruptions during
maintenance and reconfiguration tasks.

About this task

Start the server in maintenance mode by running the DSMSERV utility with the
MAINTENANCE parameter.

The following operations are disabled in maintenance mode:

v Administrative command schedules
v Client schedules
v Reclamation of storage space on the server
v Inventory expiration
v Migration of storage pools
In addition, clients are prevented from starting sessions with the server.

Tips:
v You do not have to edit the server options file, dsmserv.opt, to start the server in
maintenance mode.
v While the server is running in maintenance mode, you can manually start the
storage-space reclamation, inventory expiration, and storage-pool migration
processes.

Chapter 3. Taking the first steps after you install Version 8.1.2 67
Installing the IBM Spectrum Protect server

Procedure

To start the server in maintenance mode, issue the following command:

dsmserv maintenance

Tip: To view a video about starting the server in maintenance mode, see Starting a
server in maintenance mode.

What to do next

To resume server operations in production mode, complete the following steps:

1. Shut down the server by issuing the HALT command:
halt
2. Start the server by using the method that you use in production mode.
Operations that were disabled during maintenance mode are reenabled.

Stopping the server

You can stop the server when needed to return control to the operating system. To
avoid losing administrative and client node connections, stop the server only after
current sessions are completed or canceled.

About this task

To stop the server, issue the following command from the IBM Spectrum Protect
command line:
halt

Registering licenses
Immediately register any IBM Spectrum Protect licensed functions that you
purchase so you do not lose any data after you start server operations, such as
backing up your data.

About this task

Use the REGISTER LICENSE command for this task.

Example: Register a license

Register the base IBM Spectrum Protect license.

register license file=tsmbasic.lic

Specifying a device class in preparation for database backups

To prepare the system for automatic and manual database backups, you must
specify the device class to be used.

Before you begin

Ensure that you have defined a tape or file device class.

68 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

About this task

Complete the following steps to set up your system for database backups.

Procedure
1. If you did not use the configuration wizard (dsmicfgx) to configure the server,
ensure that you have completed the steps to manually configure the system for
database backups.
2. Select the device class to be used for backups of the database. Issue the
following command from an IBM Spectrum Protect administrative command
line.
set dbrecovery device_class_name

The device class that you specify is used by the database manager for database
backups. If you do not specify a device class with the SET DBRECOVERY
command, the backup fails.

Example

For example, to specify that the DBBACK device class is to be used, issue this
command:
set dbrecovery dbback

Running multiple server instances on a single system

You can create more than one server instance on your system. Each server instance
has its own instance directory, and database and log directories.

Multiply the memory and other system requirements for one server by the number
of instances planned for the system.

The set of files for one instance of the server is stored separately from the files
used by another server instance on the same system. Use the steps in “Creating the
server instance” on page 56 for each new instance, optionally creating the new
instance user.

To manage the system memory that is used by each server, use the DBMEMPERCENT
server option to limit the percentage of system memory. If all servers are equally
important, use the same value for each server. If one server is a production server
and other servers are test servers, set the value for the production server to a
higher value than the test servers.

You can upgrade directly from either V6.3 to V7.1. See the upgrade section
(Chapter 5, “Upgrading to V8.1,” on page 79) for more details. When you upgrade
and have multiple servers on your system, you must run the installation wizard
only once. The installation wizard collects the database and variables information
for all of your original server instances.

If you upgrade from IBM Spectrum Protect V6.3 to V8.1.2 and have multiple
servers on your system, all instances that exist in DB2 V9.7 are dropped and
recreated in DB2 V11.1. The wizard issues the db2 upgrade db dbname command
for each database. The database environment variables for each instance on your
system are also reconfigured during the upgrade process.

Chapter 3. Taking the first steps after you install Version 8.1.2 69
Installing the IBM Spectrum Protect server

A typical IBM Spectrum Protect installation involves one server instance on the
IBM Spectrum Protect server computer. You might want to install a second instance
if you are configuring in a clustered environment. You might also want to run
more than one server on a large computer if you have multiple tape libraries or a
disk-only configuration. After you install and configure the first IBM Spectrum
Protect server, use the Server Initialization wizard to create additional IBM
Spectrum Protect server instances on the same computer.

By using the Server Initialization wizard, you can install up to four IBM Spectrum
Protect server instances on a single system or cluster.
Related tasks:
Running multiple server instances on a single system (V7.1.1)

Monitoring the server

When you start to use the server in production, monitor the space that is used by
the server to ensure that the amount of space is adequate. Adjust the space if
needed.

Procedure
1. Monitor the active log to ensure that the size is correct for the workload that is
handled by the server instance.
When the server workload reaches its typical expected level, the space that is
used by the active log is 80% - 90% of the space that is available to the active
log directory. At that point, you might need to increase the amount of space.
Whether you must increase the space depends on the types of transactions in
the server workload. Transaction characteristics affect how the active log space
is used.
The following transaction characteristics can affect the space usage in the active
log:
v The number and size of files in backup operations
– Clients such as file servers that back up large numbers of small files can
cause large numbers of transactions that are completed quickly. The
transactions might use a large amount of space in the active log, but for a
short time.
– Clients such as a mail server or a database server that back up large
amounts of data in few transactions can cause small numbers of
transactions that take a long time to complete. The transactions might use
a small amount of space in the active log, but for a long time.
v Network connection types
– Backup operations that occur over fast network connections cause
transactions that complete more quickly. The transactions use space in the
active log for a shorter time.
– Backup operations that occur over relatively slower connections cause
transactions that take a longer time to complete. The transactions use
space in the active log for a longer time.
If the server is handling transactions with a wide variety of characteristics, the
space that is used for the active log might increase and decrease significantly
over time. For such a server, you might need to ensure that the active log
typically has a smaller percentage of its space used. The extra space allows the
active log to grow for transactions that take a long time to complete.
2. Monitor the archive log to ensure that space is always available.

70 IBM Spectrum Protect for Windows: Installation Guide

 Installing the IBM Spectrum Protect server

Remember: If the archive log becomes full, and the failover archive log
becomes full, the active log can become full, and the server stops. The goal is to
make enough space available to the archive log so that it never uses all its
available space.
You are likely to notice the following pattern:
a. Initially, the archive log grows rapidly as typical client-backup operations
occur.
b. Database backups occur regularly, either as scheduled or done manually.
c. After at least two full database backups occur, log pruning occurs
automatically. The space that is used by the archive log decreases when the
pruning occurs.
d. Normal client operations continue, and the archive log grows again.
e. Database backups occur regularly, and log pruning occurs as often as full
database backups occur.
With this pattern, the archive log grows initially, decreases, and then might
grow again. Over time, as normal operations continue, the amount of space
that is used by the archive log should reach a relatively constant level.
If the archive log continues to grow, consider taking one or both of these
actions:
v Add space to the archive log. You might need to move the archive log to a
different file system.
v Increase the frequency of full database backups, so that log pruning occurs
more frequently.
3. If you defined a directory for the failover archive log, determine whether any
logs get stored in that directory during normal operations. If the failover log
space is being used, consider increasing the size of the archive log. The goal is
that the failover archive log is used only under unusual conditions, not in
normal operation.

Chapter 3. Taking the first steps after you install Version 8.1.2 71
Installing the IBM Spectrum Protect server

72 IBM Spectrum Protect for Windows: Installation Guide

Chapter 4. Installing an IBM Spectrum Protect server fix pack
IBM Spectrum Protect maintenance updates, which are also referred to as fix packs,
bring your server up to the current maintenance level.

Before you begin

To install a fix pack or interim fix to the server, install the server at the level on
which you want to run it. You do not have to start the server installation at the
base release level. For example, if you currently have V8.1.1 installed, you can go
directly to the latest fix pack for V8.1. You do not have to start with the V8.1.0
installation if a maintenance update is available.

You must have the IBM Spectrum Protect license package installed. The license
package is provided with the purchase of a base release. When you download a fix
pack or interim fix from Fix Central, install the server license that is available on
the Passport Advantage website. To display messages and help in a language other
than US English, install the language package of your choice.

If you upgrade the server to V8.1.2 or later, and then revert the server to a level
that is earlier than V8.1.2, you must restore the database to a point in time before
the upgrade. During the upgrade process, complete the required steps to ensure
that the database can be restored: back up the database, the volume history file, the
device configuration file, and the server options file. For more information, see
Chapter 6, “Reverting from Version 8.1.2 to a previous server,” on page 95.

If you are using the client management service, ensure that you upgrade it to the
same version as the IBM Spectrum Protect server.

Ensure that you retain the installation media from the base release of the installed
server. If you installed IBM Spectrum Protect from a downloaded package, ensure
that the downloaded files are available. If the upgrade fails, and the server license
module is uninstalled, the installation media from the server base release are
required to reinstall the license.

Visit the IBM Support Portal for the following information:

v A list of the latest maintenance and download fixes. Click Downloads and apply
any applicable fixes.
v Details about obtaining a base license package. Search for Downloads >
Passport Advantage.
v Supported platforms and system requirements. Search for IBM Spectrum Protect
supported operating systems.

Ensure that you upgrade the server before you upgrade backup-archive clients. If
you do not upgrade the server first, communication between the server and clients
might be interrupted.

Attention: Do not alter the DB2 software that is installed with IBM Spectrum
Protect installation packages and fix packs. Do not install or upgrade to a different
version, release, or fix pack of DB2 software because doing so can damage the
database.

© Copyright IBM Corp. 1993, 2017 73

Installing an IBM Spectrum Protect fix pack

Procedure

To install a fix pack or interim fix, complete the following steps:

1. Back up the database. The preferred method is to use a snapshot backup. A
snapshot backup is a full database backup that does not interrupt any
scheduled database backups. For example, issue the following IBM Spectrum
Protect administrative command:
backup db type=dbsnapshot devclass=tapeclass
2. Back up the device configuration information. Issue the following IBM
Spectrum Protect administrative command:
backup devconfig filenames=file_name

where file_name specifies the name of the file in which to store device
configuration information.
3. Save the volume history file to another directory or rename the file. Issue the
following IBM Spectrum Protect administrative command:
backup volhistory filenames=file_name

where file_name specifies the name of the file in which to store the volume
history information.
4. Save a copy of the server options file, typically named dsmserv.opt. The file is
in the server instance directory.
5. Halt the server before installing a fix pack or interim fix. Use the HALT
command.
6. Ensure that extra space is available in the installation directory. The installation
of this fix pack might require additional temporary disk space in the
installation directory of the server. The amount of additional disk space can be
as much as that required for installing a new database as part of an IBM
Spectrum Protect installation. The IBM Spectrum Protect installation wizard
displays the amount of space that is required for installing the fix pack and the
available amount. If the required amount of space is greater than the available
amount, the installation stops. If the installation stops, add the required disk
space to the file system and restart the installation.
7. Obtain the package file for the fix pack or interim fix that you want to install
from the IBM Support Portal, Passport Advantage, or Fix Central.
8. Change to the directory where you placed the executable file. Then, either
double-click the following executable file or enter the following command on
the command line to extract the installation files.

Tip: The files are extracted to the current directory. Ensure that the executable
file is in the directory where you want the extracted files to be located.
8.x.x.x-IBM-SPSRV-platform.exe

where: platform denotes the operating system that IBM Spectrum Protect is to
be installed on.
9. Select one of the following ways of installing IBM Spectrum Protect.

Important: After a fix pack is installed, it is not necessary to go through the

configuration again. You can stop after completing the installation, fix any
errors, then restart your servers.
Install the IBM Spectrum Protect software by using one of the following
methods:

74 IBM Spectrum Protect for Windows: Installation Guide

 Installing an IBM Spectrum Protect fix pack

Installation wizard
Follow the instructions for your operating system:
“Installing IBM Spectrum Protect by using the installation wizard” on
page 46

Tip: After you start the wizard, in the IBM Installation Manager window, click
the Update icon; do not click the Install or Modify icon.
Command line in console mode
Follow the instructions for your operating system:
“Installing IBM Spectrum Protect by using console mode” on page 47
Silent mode
Follow the instructions for your operating system:
“Installing IBM Spectrum Protect in silent mode” on page 48

Tip: If you have multiple server instances on your system, run the installation
wizard only once. The installation wizard upgrades all server instances.

Results
Correct any errors that are detected during the installation process.

If you installed the server by using the installation wizard, you can view
installation logs by using the IBM Installation Manager tool. Click File > View
Log. To collect log files, from the IBM Installation Manager tool, click Help >
Export Data for Problem Analysis.

If you installed the server by using console mode or silent mode, you can view
error logs in the IBM Installation Manager log directory, for example:
C:\ProgramData\IBM\Installation Manager\logs

Applying a fix pack to IBM Spectrum Protect 8.1.2 in a clustered

environment
To take advantage of new product features, you can upgrade a server that is
installed on a Windows operating system in a clustered environment from V6.3 or
V7.1 to IBM Spectrum Protect V8.1.2.

Before you begin

Ensure that you retain the installation media from the V6.3 or V7.1 server base
release that you are upgrading. If you installed the server from a downloaded
package, ensure that the downloaded files are available. If the upgrade fails, and
the server license module is uninstalled, you must reinstall the license from the
installation media of the server base release.

Procedure
1. If you plan to install the IBM Spectrum Protect V8.1.2 server on the Windows
Server 2012 operating system, install the failover cluster automation server
and the failover cluster command interface first. To install these components,
issue the following commands from Windows 2.0 PowerShell:
Install-WindowsFeature -Name RSAT-Clustering-AutomationServer
Install-WindowsFeature -Name RSAT-Clustering-CmdInterface

Chapter 4. Installing an IBM Spectrum Protect fix pack 75

Installing an IBM Spectrum Protect fix pack

2. Back up the database by using the BACKUP DB command. The preferred method
is to use a snapshot backup, which provides a full database backup without
interrupting scheduled backups. For example, you can run the following
command to create a snapshot backup:
backup db type=dbsnapshot devclass=tapeclass
3. Back up the device configuration information to another directory. Run the
following command:
backup devconfig filenames=file_name

Where file_name specifies the name of the file in which to store device
configuration information.
4. Back up the volume history file to another directory. Run the following
command:
backup volhistory filenames=file_name

Where file_name specifies the name of the file in which to store the volume
history information.
5. Save a copy of the server options file, typically named dsmserv.opt, which is
in the server instance directory.
6. Ensure that the resource group is on the primary node, and that all nodes in
the cluster are running. Take the following actions on the primary node:
a. In the Failover Cluster Manager window, take the server resource offline
and delete it:
1) Select Services and applications, and then select the cluster group. The
server resource is displayed in the Other Resources section.
2) Select the server resource, and click Take this resource offline.
3) To delete the server resource, select it, and click Delete.
b. In the Failover Cluster Manager window, delete the network name and IP
address:
1) In the Server name section, expand the network name to view the IP
address. Note the network name and IP address.
2) Select the network name and the IP address, and click Remove.
c. In the Failover Cluster Manager window, take the DB2 server resource
offline:
1) Select Services and applications, and then select the cluster group. The
IBM Spectrum Protect server resource is displayed in the Other
Resources section.
2) Select a DB2 server resource, for example, SERVER1, and click Take
this resource offline.
7. On the primary node, run the following command to remove DB2 clustering
from each IBM Spectrum Protect instance in the cluster:
db2mscs -u:instancename

For example, run the following command to remove DB2 clustering from the
SERVER1 instance:
db2mscs -u:server1

Tip: You might see an error message about a missing cluster resource. Ignore
this message.

76 IBM Spectrum Protect for Windows: Installation Guide

 Installing an IBM Spectrum Protect fix pack

8. On the primary node, in the Failover Cluster Manager window, review the
resource group Summary section. Verify that only the shared disks and any
tape resources remain in the resource group.
9. Stop the cluster service on each node in the cluster and delete the server
cluster DLL files. Then, restart the cluster service.
10. Install the IBM Spectrum Protect V8.1.2 server on each node in the cluster. For
instructions, see Chapter 2, “Installing the server components,” on page 45. If
you use the installation wizard to install the server, in the IBM Installation
Manager window, click the Update icon. Do not click the Install or Modify
icon.
11. On the primary node, start the server in the foreground to allow the database
schema reconciliation and configuration to be completed. When the server
starts, halt it by running the HALT command. If your environment has multiple
server instances, complete this step for each instance.
12. On the primary node, start the configuration wizard by clicking Start > All
Programs > IBM Spectrum Protect server > Configuration Wizard. Complete
the following steps in the configuration wizard:
a. When you are prompted to enter the user ID, enter the name of the
domain account that is associated with the cluster.
b. When you are prompted to enter the instance name, enter the name of the
instance that you are reclustering.
c. Click Yes when you are prompted to indicate whether you want to
recluster.
d. Continue stepping through the wizard until you see a message that the
configuration was successful.
13. Register the licenses for the IBM Spectrum Protect server components that are
installed on your system by running the REGISTER LICENSE command:
register license file=installation_directory\server\component_name.lic

Where installation_directory specifies the directory in which you installed the

component and component_name specifies the abbreviation for the component.

For example, if you installed the server in the default directory, c:\Program
Files\Tivoli\TSM, run the following command to register the license:
register license file=c:\Program Files\Tivoli\TSM\server\tsmbasic.lic

For example, if you installed IBM Spectrum Protect Extended Edition in the
c:\Program Files\Tivoli\TSM directory, run the following command:
register license file=c:\Program Files\Tivoli\TSM\server\tsmee.lic

For example, if you installed IBM Spectrum Protect for Data Retention in the
c:\Program Files\Tivoli\TSM directory, run the following command:
register license file=c:\Program Files\Tivoli\TSM\server\dataret.lic

Restriction:

You cannot use the IBM Spectrum Protect server to register licenses for the
following products:
v IBM Spectrum Protect for Mail
v IBM Spectrum Protect for Databases
v IBM Spectrum Protect for ERP
v IBM Spectrum Protect for Space Management

Chapter 4. Installing an IBM Spectrum Protect fix pack 77

Installing an IBM Spectrum Protect fix pack

The REGISTER LICENSE command does not apply to these licenses. The
licensing for these products is done by IBM Spectrum Protect clients.

What to do next

If a device driver is available on Windows for the tape drives or medium changers
that you plan to use, use the device driver. If a device driver is not available,
install the IBM Spectrum Protect device driver by running the dpinst.exe /a
command. The dpinst.exe file is in the device driver directory, and the default
location is C:\Program Files\Tivoli\TSM\device\drivers.

78 IBM Spectrum Protect for Windows: Installation Guide

 Chapter 5. Upgrading to V8.1
To take advantage of new product features and updates, upgrade the IBM
Spectrum Protect server to Version 8.1.2.

| Before you begin

| Upgrade the IBM Spectrum Protect server before you update clients. For more
| information, see:

| What you should know about security before you install or upgrade the server

About this task

To upgrade the server on the same operating system, see the upgrade instructions.
For instructions about migrating the server to a different operating system, see
IBM Spectrum Protect Upgrade and Migration Process - Frequently Asked
Questions.
Table 12. Upgrade instructions
To upgrade from this
version To this version See this information
V8.1 V8.1 fix pack or interim fix
Chapter 4, “Installing an IBM
Spectrum Protect server fix
pack,” on page 73
V7.1 V8.1 “Installing the server and
verifying the upgrade” on
page 83
V7.1 V8.1 fix pack or interim fix
Chapter 4, “Installing an IBM
Spectrum Protect server fix
pack,” on page 73
V5.5, V6.2, or V6.3 V8.1 IBM Spectrum Protect
Upgrade and Migration
Process - Frequently Asked
Questions

An upgrade from V7 to V8.1 takes approximately 20 - 50 minutes. Your

environment might produce different results from the results that were obtained in
the labs.

For information about upgrades in a clustered environment, see “Upgrading the

server in a clustered environment” on page 86.

To revert to an earlier version of the server after an upgrade or migration, you

must have a full database backup and the installation software for the original
server. You must also have the following key configuration files:
v Volume history file
v Device configuration file
v Server options file

© Copyright IBM Corp. 1993, 2017 79

Upgrading the IBM Spectrum Protect server

Related information:
IBM Spectrum Protect Upgrade and Migration Process - Frequently Asked
Questions

Upgrading to V8.1
You can upgrade the server directly from V7.1 to V8.1. You do not have to
uninstall V7.1.

Before you begin

Ensure that you retain the installation media from the server base release that you
are upgrading. If you installed the server components from a DVD, ensure that the
DVD is available. If you installed the server components from a downloaded
package, ensure that the downloaded files are available. If the upgrade fails, and
the server license module is uninstalled, the installation media from the server base
release are required to reinstall the license.

Tip: DVDs are no longer available with V8.1 and later.

Procedure

To upgrade the server to V8.1, complete the following tasks:

1. “Planning the upgrade”
2. “Preparing the system” on page 81
3. “Installing the server and verifying the upgrade” on page 83

Planning the upgrade

Before you upgrade the server from V7.1 to V8.1, you must review the relevant
planning information, such as system requirements and release notes. Then, select
an appropriate day and time to upgrade the system so that you can minimize the
impact on production operations.

About this task

In lab tests, the process of upgrading the server from V7.1 to V8.1 took 14 - 45
minutes. The results that you achieve might differ, depending on your hardware
and software environment, and the size of the server database.

Procedure
1. Review the hardware and software requirements:
“Minimum system requirements for the IBM Spectrum Protect server” on page
20
For the latest updates related to system requirements, see the IBM Spectrum
Protect support website at technote 1243309.
2. For special instructions or specific information for your operating system,
review the release notes (http://www.ibm.com/support/knowledgecenter/
SSEQVQ_8.1.2/srv.common/r_relnotes_srv.html) and readme files for server
components.
3. Select an appropriate day and time to upgrade your system to minimize the
impact on production operations. The amount of time that is required to
update the system depends on the database size and many other factors. When

80 IBM Spectrum Protect for Windows: Installation Guide

 Upgrading the IBM Spectrum Protect server

you start the upgrade process, clients cannot connect to the server until the
new software is installed and any required licenses are registered again.
| 4. If you are upgrading the server from V6 or V7 to V8.1, verify that you have the
| system ID and password for the DB2 instance of the IBM Spectrum Protect
| server. These credentials are required to upgrade the system.

Preparing the system

To prepare the system for the upgrade from V7.1 to V8.1, you must gather
information about each DB2 instance. Then, back up the server database, save key
configuration files, cancel sessions, and stop the server.

Procedure
1. Log on to the computer where the server is installed.
Ensure that you are logged on with the administrative user ID that was used
to install the V7.1 server.
2. Obtain a list of DB2 instances. Issue the following system command:
db2ilist

The output might be similar to the following example:

SERVER1

Ensure that each instance corresponds to a server that is running on the

system.
3. Gather information about each DB2 instance. Note the default database path,
actual database path, database name, database alias, and any DB2 variables
that are configured for the instance. Keep the record for future reference. This
information is required to restore the V7.1 database.
a. Open the DB2 command window by issuing the following system
command:
db2cmd
b. To change the instance, issue the following system command:
set DB2INSTANCE=instance

where instance specifies the DB2 instance.

c. Obtain the default database path for the DB2 instance by issuing the
following system command:
db2 get dbm cfg | findstr DFTDBPATH

The output might be similar to the following example:

Default database path (DFTDBPATH) = D:
d. Obtain information about the DB2 instance databases by issuing the
following system command:
db2 list database directory

The output might be similar to the following example:

System Database Directory

Number of entries in the directory = 2

Database 1 entry:

Database alias = TSMAL001

Database name = TSMDB1

Chapter 5. Upgrading the server to V8.1 81

Upgrading the IBM Spectrum Protect server

Node name = TSMNODE1

Database release level = d.00
Comment = TSM SERVER DATABASE VIA TCPIP
Directory entry type = Remote
Catalog database partition number = -1
Alternate server hostname =
Alternate server port number =

Database 2 entry:

Database alias = TSMDB1

Database name = TSMDB1
Local database directory = D:
Database release level = d.00
Comment =
Directory entry type = Indirect
Catalog database partition number = 0
Alternate server hostname =
Alternate server port number =
e. Obtain the DB2 instance variables by issuing the following system
command:
db2set -all

The output might be similar to the following example:

[e] DB2CODEPAGE=1208
[e] DB2PATH=D:\TSM\db2
[i] DB2_PMODEL_SETTINGS=MAX_BACKGROUND_SYSAPPS:500
[i] DB2_SKIPINSERTED=ON
[i] DB2_KEEPTABLELOCK=OFF
[i] DB2_EVALUNCOMMITTED=ON
[i] DB2_VENDOR_INI=D:\Server1\tsmdbmgr.env
[i] DB2_SKIPDELETED=ON
[i] DB2INSTPROF=C:\ProgramData\IBM\DB2\DB2TSM1
[i] DB2COMM=TCPIP
[i] DB2CODEPAGE=819
[i] DB2_PARALLEL_IO=*
[g] DB2_EXTSECURITY=YES
[g] DB2_COMMON_APP_DATA_PATH=C:\ProgramData

[g] DB2PATH=D:\TSM\db2
[g] DB2INSTDEF=SERVER1
4. Connect to the server by using an administrative user ID.
5. Back up the database by using the BACKUP DB command. The preferred method
is to create a snapshot backup, which is a full database backup that does not
interrupt scheduled database backups. For example, you can create a snapshot
backup by issuing the following command:
backup db type=dbsnapshot devclass=tapeclass
6. Back up the device configuration information to another directory by issuing
the following administrative command:
backup devconfig filenames=file_name

where file_name specifies the name of the file in which to store device
configuration information.

Tip: If you decide to restore the V7.1 database, this file is required.
7. Back up the volume history file to another directory. Issue the following
administrative command:
backup volhistory filenames=file_name

82 IBM Spectrum Protect for Windows: Installation Guide

 Upgrading the IBM Spectrum Protect server

where file_name specifies the name of the file in which to store the volume
history information.

Tip: If you decide to restore the V7.1 database, this file is required.
8. Save a copy of the server options file, which is typically named dsmserv.opt.
The file is in the server instance directory.
9. Prevent activity on the server by disabling new sessions. Issue the following
administrative commands:
disable sessions client
disable sessions server
10. Verify whether any sessions exist, and notify the users that the server will be
stopped. To check for existing sessions, issue the following administrative
command:
query session
11. Cancel sessions by issuing the following administrative command:
cancel session all

This command cancels all sessions except for your current session.
12. Stop the server by issuing the following administrative command:
halt
13. Verify that the server is shut down and no processes are running.
Open the Windows Task Manager application and review the list of active
processes.
14. In the server instance directory of your installation, locate the NODELOCK file
and move it to another directory, where you are saving configuration files.
The NODELOCK file contains the previous licensing information for your
installation. This licensing information is replaced when the upgrade is
complete.

Installing the server and verifying the upgrade

To complete the process of upgrading the server to V8.1, you must install the V8.1
server. Then, verify that the upgrade was successful by starting the server instance.

Before you begin

You must be logged on to the system with the administrative user ID that was
used to install the previous server.

You can obtain the installation package from an IBM download site.

About this task

By using the IBM Spectrum Protect installation software, you can install the
following components:
v Server

Tip: The database (DB2), the Global Security Kit (GSKit), and IBM Java Runtime
Environment (JRE) are automatically installed when you select the server
component.
v Server languages
v License
v Devices

Chapter 5. Upgrading the server to V8.1 83

Upgrading the IBM Spectrum Protect server

v IBM Spectrum Protect for SAN

v Operations Center

Procedure
1. Download the appropriate package file from one of the following websites:
v Download the server package from Passport Advantage or Fix Central.
v For the most recent information, updates, and maintenance fixes, go to the
IBM Support Portal.
2. Complete the following steps:

a. Verify that you have enough space to store the installation files
when they are extracted from the product package. For space
requirements, see the download document for your product.
v IBM Spectrum Protect technote 4042944
v IBM Spectrum Protect Extended Edition technote 4042945
v IBM Spectrum Protect for Data Retention technote 4042946
b. Change to the directory where you placed the executable file.

Tip: In the next step, the files are extracted to the current directory.
The path must contain no more than 128 characters. Be sure to
extract the installation files to an empty directory. Do not extract to
a directory that contains previously extracted files, or any other
files.
c. To extract the installation files, double-click the executable file:
package_name.exe
Where package_name is similar to the following example:
8.1.x.000-SPSRV-WindowsX64.exe
The package is large. Therefore, the extraction takes some time.
3. Install the IBM Spectrum Protect software by using one of the following
methods. Install the IBM Spectrum Protect license during the installation
process.

Tip: If you have multiple server instances on your system, install the IBM
Spectrum Protect software only one time to upgrade all server instances.
Installation wizard
To install the server by using the graphical wizard of IBM Installation
Manager, follow the instructions in “Installing IBM Spectrum Protect by
using the installation wizard” on page 46.
Ensure that your system meets the prerequisites for using the
installation wizard. Then, complete the installation procedure. In the
IBM Installation Manager window, click the Update or Modify icon.
Installing the server by using the console mode
To install the server by using the console mode, follow the instructions
in “Installing IBM Spectrum Protect by using console mode” on page
47.
Review the information about installing the server in console mode and
then complete the installation procedure.
Silent mode

84 IBM Spectrum Protect for Windows: Installation Guide

 Upgrading the IBM Spectrum Protect server

To install the server by using silent mode, follow the instructions in

“Installing IBM Spectrum Protect in silent mode” on page 48.
Review the information about installing the server in silent mode and
then complete the installation procedure.
After you install the software, you do not have to reconfigure the system.
4. Correct any errors that are detected during the installation process.
If you installed the server by using the installation wizard, you can view
installation logs by using the IBM Installation Manager tool. Click File > View
Log. To collect log files, from the IBM Installation Manager tool, click Help >
Export Data for Problem Analysis.
If you installed the server by using console mode or silent mode, you can view
error logs in the IBM Installation Manager log directory, for example:
C:\ProgramData\IBM\Installation Manager\logs
5. Go to the IBM Support Portal to obtain fixes. Click Fixes, updates, and drivers
and apply any applicable fixes.
6. Verify that the upgrade was successful:
a. Start the server instance. To start the server from the default directory,
C:\Program Files\Tivoli\TSM, run the following IBM Spectrum Protect
administrative command:
dsmserv -k server_instance

server_instance is the name of your server instance. Server1 is the default

name for the first instance of the IBM Spectrum Protect server.
If you plan to run the server as a service under the Local System account,
the Local System account must be explicitly granted access to the server
database. For instructions, see “Starting the server as a Windows service”
on page 65.
b. Monitor the messages that the server issues as it starts. Watch for error and
warning messages, and resolve any issues.
c. Verify that you can connect to the server by using the administrative client.
To start an administrative client session, run the following IBM Spectrum
Protect administrative command:
dsmadmc
d. To obtain information about the upgraded system, run QUERY commands.
For example, to obtain consolidated information about the system, run the
following IBM Spectrum Protect administrative command:
query system

To obtain information about the database, run the following IBM Spectrum
Protect administrative command:
query db format=detailed
7. Register the licenses for the server components that are installed on your
system by running the REGISTER LICENSE command:
register license file=installation_directory\server\component_name.lic

Where installation_directory specifies the directory in which you installed the

component, and component_name specifies the abbreviation for the component.

For example, if you installed the server in the default directory, c:\Program
Files\Tivoli\TSM, run the following command to register the license:
register license file=c:\Program Files\Tivoli\TSM\server\tsmbasic.lic

Chapter 5. Upgrading the server to V8.1 85

Upgrading the IBM Spectrum Protect server

For example, if you installed IBM Spectrum Protect Extended Edition in the
c:\Program Files\Tivoli\TSM directory, run the following command:
register license file=c:\Program Files\Tivoli\TSM\server\tsmee.lic

For example, if you installed IBM Spectrum Protect for Data Retention in the
c:\Program Files\Tivoli\TSM directory, run the following command:
register license file=c:\Program Files\Tivoli\TSM\server\dataret.lic

Restriction:

You cannot use the IBM Spectrum Protect server to register licenses for the
following products:
v IBM Spectrum Protect for Mail
v IBM Spectrum Protect for Databases
v IBM Spectrum Protect for ERP
v IBM Spectrum Protect for Space Management
The REGISTER LICENSE command does not apply to these licenses. The licensing
for these products is done by IBM Spectrum Protect clients.
8. Optional: To install an extra language package, use the modify function of the
IBM Installation Manager.
9. Optional: To upgrade to a newer version of a language package, use the update
function of the IBM Installation Manager.

What to do next
You can authenticate passwords with the LDAP directory server, or authenticate
passwords with the IBM Spectrum Protect server. Passwords that are authenticated
with the LDAP directory server can provide enhanced system security.

If a device driver is available on Windows for the tape drives or medium changers
that you plan to use, use the device driver. If a device driver is not available on
Windows for the tape drives or medium changers that you plan to use, install the
IBM Spectrum Protect device driver by running the dpinst.exe /a command. The
dpinst.exe file is in the device driver directory. The default directory is C:\Program
Files\Tivoli\TSM\device\drivers.

Upgrading the server in a clustered environment

To upgrade a server to V8.1.2 in a clustered environment, you must complete
preparation and installation tasks. The procedures vary, depending on the
operating system and release.

Procedure
Follow the procedure for your operating system, source release, and target release:
Table 13. Procedures for upgrading the server in a clustered environment on a Windows
operating system
Source release Target release Procedure
V8.1.2 V8.1.2 fix pack “Applying a fix pack to IBM Spectrum Protect 8.1.2 in
a clustered environment” on page 75
V6.3 or V7.1 V8.1.2 Upgrading V6.3 or V7.1 to V8.1 in a clustered
environment on Windows

86 IBM Spectrum Protect for Windows: Installation Guide

 Upgrading the IBM Spectrum Protect server

Table 13. Procedures for upgrading the server in a clustered environment on a Windows
operating system (continued)
Source release Target release Procedure
V6.1 V8.1.2 Upgrading V6.1 to V8.1 in a clustered environment on
Windows
V5 V7.1 or later Upgrading the server to V7.1 or later in a Windows
clustered environment

Upgrading a V6.3 or V7.1 server to V8.1.2 in a clustered

environment
To take advantage of new product features, you can upgrade a server that is
installed on a Windows operating system in a clustered environment from V6.3 or
V7.1 to IBM Spectrum Protect V8.1.2.

Before you begin

Ensure that you retain the installation media from the V6.3 or V7.1 server base
release that you are upgrading. If you installed the server from a downloaded
package, ensure that the downloaded files are available. If the upgrade fails, and
the server license module is uninstalled, you must reinstall the license from the
installation media of the server base release.

Procedure
1. If you plan to install the IBM Spectrum Protect V8.1.2 server on the Windows
Server 2012 operating system, install the failover cluster automation server
and the failover cluster command interface first. To install these components,
issue the following commands from Windows 2.0 PowerShell:
Install-WindowsFeature -Name RSAT-Clustering-AutomationServer
Install-WindowsFeature -Name RSAT-Clustering-CmdInterface
2. Back up the database by using the BACKUP DB command. The preferred method
is to use a snapshot backup, which provides a full database backup without
interrupting scheduled backups. For example, you can run the following
command to create a snapshot backup:
backup db type=dbsnapshot devclass=tapeclass
3. Back up the device configuration information to another directory. Run the
following command:
backup devconfig filenames=file_name

Where file_name specifies the name of the file in which to store device
configuration information.
4. Back up the volume history file to another directory. Run the following
command:
backup volhistory filenames=file_name

Where file_name specifies the name of the file in which to store the volume
history information.
5. Save a copy of the server options file, typically named dsmserv.opt, which is
in the server instance directory.
6. Ensure that the resource group is on the primary node, and that all nodes in
the cluster are running. Take the following actions on the primary node:

Chapter 5. Upgrading the server to V8.1 87

Upgrading the IBM Spectrum Protect server

a. In the Failover Cluster Manager window, take the server resource offline
and delete it:
1) Select Services and applications, and then select the cluster group. The
server resource is displayed in the Other Resources section.
2) Select the server resource, and click Take this resource offline.
3) To delete the server resource, select it, and click Delete.
b. In the Failover Cluster Manager window, delete the network name and IP
address:
1) In the Server name section, expand the network name to view the IP
address. Note the network name and IP address.
2) Select the network name and the IP address, and click Remove.
c. In the Failover Cluster Manager window, take the DB2 server resource
offline:
1) Select Services and applications, and then select the cluster group. The
IBM Spectrum Protect server resource is displayed in the Other
Resources section.
2) Select a DB2 server resource, for example, SERVER1, and click Take
this resource offline.
7. On the primary node, run the following command to remove DB2 clustering
from each IBM Spectrum Protect instance in the cluster:
db2mscs -u:instancename

For example, run the following command to remove DB2 clustering from the
SERVER1 instance:
db2mscs -u:server1

Tip: You might see an error message about a missing cluster resource. Ignore
this message.
8. On the primary node, in the Failover Cluster Manager window, review the
resource group Summary section. Verify that only the shared disks and any
tape resources remain in the resource group.
9. Stop the cluster service on each node in the cluster and delete the server
cluster DLL files. Then, restart the cluster service.
10. Install the IBM Spectrum Protect V8.1.2 server on each node in the cluster. For
instructions, see Chapter 2, “Installing the server components,” on page 45. If
you use the installation wizard to install the server, in the IBM Installation
Manager window, click the Update icon. Do not click the Install or Modify
icon.
11. On the primary node, start the server in the foreground to allow the database
schema reconciliation and configuration to be completed. When the server
starts, halt it by running the HALT command. If your environment has multiple
server instances, complete this step for each instance.
12. On the primary node, start the configuration wizard by clicking Start > All
Programs > IBM Spectrum Protect server > Configuration Wizard. Complete
the following steps in the configuration wizard:
a. When you are prompted to enter the user ID, enter the name of the
domain account that is associated with the cluster.
b. When you are prompted to enter the instance name, enter the name of the
instance that you are reclustering.
c. Click Yes when you are prompted to indicate whether you want to
recluster.

88 IBM Spectrum Protect for Windows: Installation Guide

 Upgrading the IBM Spectrum Protect server

d. Continue stepping through the wizard until you see a message that the
configuration was successful.
13. Register the licenses for the IBM Spectrum Protect server components that are
installed on your system by running the REGISTER LICENSE command:
register license file=installation_directory\server\component_name.lic

Where installation_directory specifies the directory in which you installed the

component and component_name specifies the abbreviation for the component.

For example, if you installed the server in the default directory, c:\Program
Files\Tivoli\TSM, run the following command to register the license:
register license file=c:\Program Files\Tivoli\TSM\server\tsmbasic.lic

For example, if you installed IBM Spectrum Protect Extended Edition in the
c:\Program Files\Tivoli\TSM directory, run the following command:
register license file=c:\Program Files\Tivoli\TSM\server\tsmee.lic

For example, if you installed IBM Spectrum Protect for Data Retention in the
c:\Program Files\Tivoli\TSM directory, run the following command:
register license file=c:\Program Files\Tivoli\TSM\server\dataret.lic

Restriction:

You cannot use the IBM Spectrum Protect server to register licenses for the
following products:
v IBM Spectrum Protect for Mail
v IBM Spectrum Protect for Databases
v IBM Spectrum Protect for ERP
v IBM Spectrum Protect for Space Management
The REGISTER LICENSE command does not apply to these licenses. The
licensing for these products is done by IBM Spectrum Protect clients.

What to do next

If a device driver is available on Windows for the tape drives or medium changers
that you plan to use, use the device driver. If a device driver is not available,
install the IBM Spectrum Protect device driver by running the dpinst.exe /a
command. The dpinst.exe file is in the device driver directory, and the default
location is C:\Program Files\Tivoli\TSM\device\drivers.

Upgrading IBM Tivoli Storage Manager V6.1 to IBM Spectrum

Protect V8.1.2 in a clustered environment
To take advantage of new features, you can upgrade a server that is installed on a
Windows operating system in a clustered environment from V6.1 to V8.1.2.

Before you begin

Ensure that you retain the installation media from the V6.1 and V6.3 server base
releases. If you obtained the server software from a downloaded package, ensure
that the downloaded files are available. If the upgrade fails, and the server license
module is uninstalled, the installation media from the server base release are
required to reinstall the license.

Chapter 5. Upgrading the server to V8.1 89

Upgrading the IBM Spectrum Protect server

Procedure
1. If you plan to install the IBM Spectrum Protect V8.1.2 server on the Windows
Server 2012 operating system, install the failover cluster automation server
and the failover cluster command interface first. To install these components,
issue the following commands from Windows 2.0 PowerShell:
Install-WindowsFeature -Name RSAT-Clustering-AutomationServer
Install-WindowsFeature -Name RSAT-Clustering-CmdInterface
2. Back up the database by using the BACKUP DB command. The preferred method
is to use a snapshot backup, which provides a full database backup without
interrupting scheduled backups. For example, you can run the following
command to create a snapshot backup:
backup db type=dbsnapshot devclass=tapeclass
3. Back up the device configuration information to another directory. Run the
following command:
backup devconfig filenames=file_name

Where file_name specifies the name of the file in which to store device
configuration information.
4. Back up the volume history file to another directory. Run the following
command:
backup volhistory filenames=file_name

Where file_name specifies the name of the file in which to store the volume
history information.
5. Save a copy of the server options file, typically named dsmserv.opt, which is
in the server instance directory.
6. Ensure that the resource group is on the primary node, and that all nodes in
the cluster are running. Take the following actions on the primary node:
a. In the Failover Cluster Manager window, take the server resource offline
and delete it:
1) Select Services and applications, and then select the cluster group. The
server resource is displayed in the Other Resources section.
2) Select the server resource, and click Take this resource offline.
3) To delete the server resource, select it, and click Delete.
b. In the Failover Cluster Manager window, delete the network name and IP
address:
1) In the Server name section, expand the network name to view the IP
address. Note the network name and IP address.
2) Select the network name and the IP address, and click Remove.
c. In the Failover Cluster Manager window, take the DB2 server resource
offline:
1) Select Services and applications, and then select the cluster group. The
IBM Spectrum Protect server resource is displayed in the Other
Resources section.
2) Select a DB2 server resource, for example, SERVER1, and click Take
this resource offline.
7. On the primary node, to remove DB2 clustering from the instance, for each
IBM Spectrum Protect instance in the cluster, issue the following command:
db2mscs -u:instancename

For example:

90 IBM Spectrum Protect for Windows: Installation Guide

 Upgrading the IBM Spectrum Protect server

db2mscs -u:server1

Tip: You might see an error message about a missing cluster resource. Ignore
this message.
8. On the primary node, in the Failover Cluster Manager window, in the
resource group Summary section, verify that only the shared disks and any
tape resources remain in the resource group.
9. On the primary node, install the V6.3 server by using the install.exe
command. For detailed instructions about installing the V6.3 server, see
Installing the server components.
10. On the primary node, install the IBM Spectrum Protect V8.1.2 server. For
instructions, see Chapter 2, “Installing the server components,” on page 45. If
you use the installation wizard to install the server, in the IBM Installation
Manager window, click the Install icon. Do not click the Update or Modify
icon.
11. On each secondary node, uninstall V6.1:
a. Change to the following directory:
C:\Program Files\Tivoli\TSM\_uninst
b. Issue the following command:
Uninstall Tivoli Storage Manager.exe
12. On the primary node, start the configuration wizard by clicking Start > All
Programs > IBM Spectrum Protect server > Configuration Wizard. Step
through the configuration wizard:
a. When you are prompted to enter the instance name, enter the name of the
instance that you are reclustering.
b. When you are prompted to enter the user ID, enter the name of the
domain account that is associated with the cluster.
c. When you are prompted to indicate whether you want to recluster, click
Yes.
d. Continue stepping through the wizard until you see a message that the
configuration was successful.
13. Register the licenses for the IBM Spectrum Protect server components that are
installed on your system by running the REGISTER LICENSE command:
register license file=installation_directory\server\component_name.lic

Where installation_directory specifies the directory in which you installed the

component and component_name specifies the abbreviation for the component.

For example, if you installed the server in the default directory, c:\Program
Files\Tivoli\TSM, run the following command to register the license:
register license file=c:\Program Files\Tivoli\TSM\server\tsmbasic.lic

For example, if you installed IBM Spectrum Protect Extended Edition in the
c:\Program Files\Tivoli\TSM directory, run the following command:
register license file=c:\Program Files\Tivoli\TSM\server\tsmee.lic

For example, if you installed IBM Spectrum Protect for Data Retention in the
c:\Program Files\Tivoli\TSM directory, run the following command:
register license file=c:\Program Files\Tivoli\TSM\server\dataret.lic

Restriction:

Chapter 5. Upgrading the server to V8.1 91

Upgrading the IBM Spectrum Protect server

You cannot use the IBM Spectrum Protect server to register licenses for the
following products:
v IBM Spectrum Protect for Mail
v IBM Spectrum Protect for Databases
v IBM Spectrum Protect for ERP
v IBM Spectrum Protect for Space Management
The REGISTER LICENSE command does not apply to these licenses. The
licensing for these products is done by IBM Spectrum Protect clients.

What to do next

If a device driver is available on Windows for the tape drives or medium changers
that you plan to use, use the device driver. If a device driver is not available,
install the IBM Spectrum Protect device driver by running the dpinst.exe /a
command. The dpinst.exe file is in the device driver directory, and the default
location is C:\Program Files\Tivoli\TSM\device\drivers.

Removing GSKit Version 7 after upgrading to IBM Spectrum Protect

Version 8.1.2
The IBM Spectrum Protect installation wizard upgrades GSKit Version 8 and later.
GSKit Version 7 is not removed or upgraded when you upgrade to IBM Spectrum
Protect Version 8.1.2, even if GSKit was installed with an earlier version of IBM
Spectrum Protect.

About this task

If you no longer need GSKit V7 and want to free up space on your system, you
can remove it after the upgrade to IBM Spectrum Protect V8.1.2.

Important: Removing GSKit V7 might affect other programs on your system that
rely on it.

Procedure

To remove GSKit V7, complete the following steps:

1. Back up your registry.
a. Click Start, and then click Run.
b. Type Regedit. Click OK.
c. To save a copy of your registry, select File > Export.
d. If you must later restore the registry, select File > Import.
For more information, see the Windows documentation.
2. Locate the directory where the GSKit is installed. The default directory is
C:\Program Files\IBM\gsk7\.
3. Remove the GSKit installation directory, gsk7, and all subfiles and directories.
Right-click the folder and click Delete.
4. Remove the GSKit 7 registry key and all subkeys and values.

Important: Removing the wrong key can cause system problems such as not
being able to restart the workstation.
a. Click Start, and then click Run.

92 IBM Spectrum Protect for Windows: Installation Guide

 Upgrading the IBM Spectrum Protect server

b. Type Regedit. Click OK.

c. The GSKit registry key is in this directory: HKEY_LOCAL_MACHINE\SOFTWARE\
IBM. Right-click the registry key, HKEY_LOCAL_MACHINE\SOFTWARE\IBM\GSK7,
and click Delete.

Chapter 5. Upgrading the server to V8.1 93

Upgrading the IBM Spectrum Protect server

94 IBM Spectrum Protect for Windows: Installation Guide

Chapter 6. Reverting from Version 8.1.2 to a previous server
If you must revert to the previous version of the server after an upgrade, you must
have a full database backup from your original version. You must also have the
server installation media for your original version and key configuration files.
Carefully follow the preparation steps before you upgrade the server. By doing so,
it might be possible to revert to the previous version of the IBM Spectrum Protect
server with minimal loss of data.

Before you begin

You must have the following items from the earlier version of the server:
v Server database backup
v Volume history file
v Device configuration file
v Server options file

About this task

Use the same instructions whether you are reverting within releases or to an earlier
release, for example, from 8.1.2 to 8.1.1 or from 8.1.2 to 7.1.2. The older version
must match the version that you used before the upgrade to V8.1.

Attention: Specify the REUSEDELAY parameter to help prevent backup-archive

client data loss when you revert the server to a previous version.

Steps for reverting to the previous server version

About this task
Complete the following steps on the system that has the V8.1 server.

Procedure
1. Halt the server to shut down all server operations by using the HALT
command.
2. Remove the database from the database manager, then delete the database and
recovery log directories.
a. Manually remove the database. One way to remove it is by issuing this
command:
dsmserv -k instance_name removedb tsmdb1
b. If you must reuse the space that is occupied by the database and recovery
log directories, you can now delete these directories.
3. Use the uninstallation program to uninstall the V8.1 server. Uninstallation
removes the server and the database manager, with their directories. For
details, see Chapter 8, “Uninstalling IBM Spectrum Protect,” on page 103.
4. Stop the cluster service. Reinstall the version of the server program that you
were using before the upgrade to V8.1.2. This version must match the version
that your server was running when you created the database backup that you
restore in a later step. For example, the server was at V7.1.7 before the

© Copyright IBM Corp. 1993, 2017 95

Reverting to a previous server version

upgrade, and you intend to use the database backup that was in use on this
server. You must install the V7.1.7 fix pack to be able to restore the database
backup.
5. Configure the new server database by using the configuration wizard. To start
the wizard, issue the following command:
/dsmicfgx
6. Ensure that no servers are running in the background.
7. Restore the database to a point in time before the upgrade.
8. Copy the following files to the instance directory.
v Device configuration file
v Volume history file
v The server options file (typically dsmserv.opt)
9. If you enabled data deduplication for any FILE-type storage pools that existed
before the upgrade, or if you moved data that existed before the upgrade into
new storage pools while using the V8.1.2 server, you must complete
additional recovery steps. For more details, see “Additional recovery steps if
you created new storage pools or enabled data deduplication.”
10. If the REUSEDELAY parameter setting on storage pools is less than the age of the
database that you restored, restore volumes on any sequential-access storage
pools that were reclaimed after that database backup. Use the RESTORE VOLUME
command.
If you do not have a backup of a storage pool, audit the reclaimed volumes
by using the AUDIT VOLUME command, with the FIX=YES parameter to resolve
inconsistencies. For example:
audit volume volume_name fix=yes
11. If client backup or archive operations were completed using the V8.1 server,
audit the storage pool volumes on which the data was stored.

Additional recovery steps if you created new storage pools or enabled

data deduplication
If you created new storage pools, turned on data deduplication for any FILE-type
storage pools, or did both while your server was running as a V8.1.2 server, you
must complete more steps to return to the previous server version.

Before you begin

To complete this task, you must have a complete backup of the storage pool that
was created before the upgrade to V8.1.2.

About this task

Use this information if you did either or both of the following actions while your
server was running as a V8.1.2 server:
v You enabled the data deduplication function for any storage pools that existed
before the upgrade to V8.1.2 program. Data deduplication applies only to
storage pools that use a FILE device type.
v You created new primary storage pools after the upgrade and moved data that
was stored in other storage pools into the new storage pools.

Complete these steps after the server is again restored to V7.

96 IBM Spectrum Protect for Windows: Installation Guide

 Reverting to a previous server version

Procedure
v For each storage pool for which you enabled the data deduplication function,
restore the entire storage pool by using the RESTORE STGPOOL command.
v For storage pools that you created after the upgrade, determine what action to
take. Data that was moved from existing V8 storage pools into the new storage
pools might be lost because the new storage pools no longer exist in your
restored V8 server. Possible recovery depends on the type of storage pool:
– If data was moved from V8 DISK-type storage pools into a new storage pool,
space that was occupied by the data that was moved was probably reused.
Therefore, you must restore the original V8 storage pools by using the storage
pool backups that were created before the upgrade to V8.1.2.
If no data was moved from V8 DISK-type storage pools into a new storage
pool, then audit the storage pool volumes in these DISK-type storage pools.
– If data was moved from V8 sequential-access storage pools into a new storage
pool, that data might still exist and be usable in storage pool volumes on the
restored V8 server. The data might be usable if the REUSEDELAY parameter for
the storage pool was set to a value that prevented reclamation while the
server was running as a V8.1.2 server. If any volumes were reclaimed while
the server was running as a V8.1.2 server, restore those volumes from storage
pool backups that were created before the upgrade to V8.1.2.

Reverting to the previous server version in a cluster configuration

If you must revert to the previous version of the server after an upgrade, you must
have a full database backup from your original version. You must also have the
server installation media for your original version and key configuration files.
Carefully follow the preparation steps before you upgrade the server. By doing so,
it might be possible to revert to the previous version of the IBM Spectrum Protect
server with minimal loss of data.

Before you begin

You must have the following items from the earlier version of the server:
v Server database backup
v Volume history file
v Device configuration file
v Server options file

Steps for reverting to the previous server version

Carefully follow the preparation steps before you upgrade the server. By doing so,
it might be possible to revert to the previous version of the server with minimal
loss of data.

About this task

Complete the following steps on the system that has the Version 8.1.2 server.

Procedure
1. Delete the IBM Spectrum Protect server resource and the network resource in
Microsoft Failover Cluster Manager.
a. Open Failover Cluster Manager. Under Other Resources, right-click the
IBM Spectrum Protect instance resource. Select Take this resource offline.

Chapter 6. Reverting from Version 8.1.2 to a previous server 97

Reverting to a previous server version

b. Delete the IBM Spectrum Protect instance.

c. Under Server Name, expand the network name and record the cluster
TCP/IP address.
d. Delete the network name.
2. Remove the DB2 cluster from the instance by issuing the following command:
DB2mscs -u:instance_name

For example, if the server instance is Server1, enter the command:

db2mscs -u:Server1

Tip: You might see an error message about a missing cluster resource.
Disregard this message.
3. Remove the database. One way to remove it is by issuing this command:
dsmserv -k instance_name removedb tsmdb1
4. On each system in the cluster, delete the V 8.1.2 tsmsvrrsc DLL files by
completing the following steps:
a. Stop the cluster service. One way to stop it is by using the Services
Application. Right-click Cluster Service and select Stop.
b. Delete the tsmsvrrscexX64.dll and tsmsvrrscx64.dll files from the
C:\Windows\Cluster directory.
c. Start the cluster service. One way to start it is by using the Services
Application. Right-click Cluster Service and select Start.
5. Use the uninstallation program to uninstall the V8.1 server. Uninstallation
removes the server and the database manager, with their directories. For
details, see Chapter 8, “Uninstalling IBM Spectrum Protect,” on page 103.
6. Clean up the database and recovery log directories if you are reusing them.
7. Stop the cluster service. Reinstall the version of the server program that you
were using before the upgrade to V8.1.2. This version must match the version
that your server was running when you created the database backup that you
restore in a later step. For example, the server was at V7.1.7 before the
upgrade, and you intend to use the database backup that was in use on this
server. You must install the V7.1.7 fix pack to be able to restore the database
backup.
8. Copy the following files to the instance directory.
v Device configuration file
v Volume history file
v The server options file (typically dsmserv.opt)
9. Use the configuration wizard (dsmicfgx) to recreate the server instance.
10. Restore the database to a point in time before the upgrade.

98 IBM Spectrum Protect for Windows: Installation Guide

Chapter 7. Reference: DB2 commands for IBM Spectrum
Protect server databases
Use this list as reference when you are directed to issue DB2 commands by IBM
support.

Purpose

After using the wizards to install and configure IBM Spectrum Protect, you seldom
need to issue DB2 commands. A limited set of DB2 commands that you might use
or be asked to issue are listed in Table 14. This list is supplemental material only
and is not a comprehensive list. There is no implication that an IBM Spectrum
Protect administrator will use it on a daily or ongoing basis. Samples of some
commands are provided. Details of output are not listed.

For a full explanation of the commands described here and of their syntax, see the
DB2 product information.
Table 14. DB2 commands
Command Description Example
db2cmd Opens the command line processor DB2 Open the DB2 command window:
window, and initializes the DB2 db2cmd
command-line environment.
db2icrt Creates DB2 instances in the home Manually create an IBM Spectrum Protect
directory of the instance owner. instance. Enter the command on one line:
Tip: The IBM Spectrum Protect /opt/tivoli/tsm/db2/instance/
configuration wizard creates the instance db2icrt -a server -u
used by the server and database. After a instance_name instance_name
server is installed and configured through
the configuration wizard, the db2icrt
command is generally not used.

This utility is located in the DB2PATH\bin

directory where DB2PATH is the location
where the DB2 copy is installed.
db2set Displays DB2 variables. List DB2 variables:
db2set
CATALOG DATABASE Stores database location information in the Catalog the database:
system database directory. The database db2 catalog database tsmdb1
can be located either on the local
workstation or on a remote database
partition server. The server configuration
wizard takes care of any catalog needed
for using the server database. Run this
command manually, after a server is
configured and running, only if something
in the environment changes or is
damaged.
CONNECT TO DATABASE Connects to a specified database for Connect to the IBM Spectrum Protect
command-line interface (CLI) use. database from a DB2 CLI:
db2 connect to tsmdb1

© Copyright IBM Corp. 1993, 2017 99

Reference: DB2 commands for IBM Spectrum Protect server databases

Table 14. DB2 commands (continued)

Command Description Example
GET DATABASE CONFIGURATION Returns the values of individual entries in Show the configuration information for a
a specific database configuration file. database alias:
Important: This command and db2 get db cfg for tsmdb1
parameters are set and managed directly
by DB2. They are listed here for
Retrieve information in order to verify
informational purposes and a means to
settings such as database configuration,
view the existing settings. Changing these
log mode, and maintenance.
settings might be advised by IBM support
or through service bulletins such as db2 get db config for tsmdb1
APARs or Technical Guidance documents show detail
(technotes). Do not change these settings
manually. Change them only at the
direction of IBM and only through the use
of IBM Spectrum Protect server
commands or procedures.
GET DATABASE MANAGER CONFIGURATION Returns the values of individual entries in Retrieve configuration information for the
a specific database configuration file. database manager:
Important: This command and db2 get dbm cfg
parameters are set and managed directly
by DB2. They are listed here for
informational purposes and a means to
view the existing settings. Changing these
settings might be advised by IBM support
or through service bulletins such as
APARs or Technical Guidance documents
(technotes). Do not change these settings
manually. Change them only at the
direction of IBM and only through the use
of IBM Spectrum Protect server
commands or procedures.
GET HEALTH SNAPSHOT Retrieves the health status information for Receive a report on DB2 health monitor
the database manager and its databases. indicators:
The information returned represents a db2 get health snapshot for
snapshot of the health state at the time database on tsmdb1
the command was issued. IBM Spectrum
Protect monitors the state of the database
using the health snapshot and other
mechanisms that are provided by DB2.
There might be cases where the health
snapshot or other DB2 documentation
indicates that an item or database
resource might be in an alert state. Such a
case indicates that action must be
considered to remedy the situation. IBM
Spectrum Protect monitors the condition
and responds appropriately. Not all
declared alerts by the DB2 database are
acted on.
GRANT (Database Authorities) Grants authorities that apply to the entire Grant access to the user ID itmuser:
database rather than privileges that apply db2 GRANT CONNECT ON DATABASE
to specific objects within the database. TO USER itmuser
db2 GRANT CREATETAB ON DATABASE
TO USER itmuser

100 IBM Spectrum Protect for Windows: Installation Guide

 Reference: DB2 commands for IBM Spectrum Protect server databases

Table 14. DB2 commands (continued)

Command Description Example
RUNSTATS Updates statistics about the characteristics Update statistics on a single table.
of a table and associated indexes or db2 runstats on table
statistical views. These characteristics SCHEMA_NAME.TABLE_NAME
include number of records, number of with distribution and sampled
pages, and average record length. detailed indexes all

To see a table, issue this utility after

updating or reorganizing the table.

A view must be enabled for optimization

before its statistics can be used to
optimize a query. A view that is enabled
for optimization is known as a statistical
view. Use the DB2 ALTER VIEW statement
to enable a view for optimization. Issue
the RUNSTATS utility when changes to
underlying tables substantially affect the
rows returned by the view.
Tip: The server configures DB2 to run the
RUNSTATS command as needed.
set db2instance Determines which instance applies to the Determine which instance is applicable:
current session. set db2instance=tsminst1
SET SCHEMA Changes the value of the CURRENT SCHEMA Set the schema for IBM Spectrum Protect:
special register, in preparation for issuing db2 set schema tsmdb1
SQL commands directly through the DB2
CLI.
Tip: A special register is a storage area
that is defined for an application process
by the database manager. It is used to
store information that can be referenced in
SQL statements.
START DATABASE MANAGER Starts the current database manager Start the database manager:
instance background processes. The server db2start
starts and stops the instance and database
whenever the server starts and halts.
Important: Allow the server to manage
the starting and stopping of the instance
and database unless otherwise directed by
IBM support.
STOP DATABASE MANAGER Stops the current database manager Stop the database manager:
instance. Unless explicitly stopped, the db2 stop dbm
database manager continues to be active.
This command does not stop the database
manager instance if any applications are
connected to databases. If there are no
database connections, but there are
instance attachments, the command forces
the instance attachments to stop first.
Then, it stops the database manager. This
command also deactivates any
outstanding database activations before
stopping the database manager.

This command is not valid on a client.

The server starts and stops the instance

and database whenever the server starts
and halts.
Important: Allow the server to manage
the starting and stopping of the instance
and database unless otherwise directed by
IBM support.

Chapter 7. Reference: DB2 commands for server databases 101

102 IBM Spectrum Protect for Windows: Installation Guide
Chapter 8. Uninstalling IBM Spectrum Protect
You can use the following procedures to uninstall IBM Spectrum Protect. Before
you remove IBM Spectrum Protect, ensure that you do not lose your backup and
archive data.

Before you begin

Complete the following steps before you uninstall IBM Spectrum Protect:
v Complete a full database backup.
v Save a copy of the volume history and device configuration files.
v Store the output volumes in a safe location.

Attention: Do not use the Add/Remove Programs tool in the Windows Control
Panel to uninstall IBM Spectrum Protect. Use only the uninstallation procedure
that is described in this section.

About this task

You can uninstall IBM Spectrum Protect by using any of the following methods: a
graphical wizard, the command line in console mode, or silent mode.

“Uninstalling IBM Spectrum Protect by using a graphical wizard”

“Uninstalling IBM Spectrum Protect in console mode” on page 104

“Uninstalling IBM Spectrum Protect in silent mode” on page 104

What to do next

See Chapter 2, “Installing the server components,” on page 45 for installation steps
to reinstall the IBM Spectrum Protect components.

Uninstalling IBM Spectrum Protect by using a graphical wizard

You can uninstall IBM Spectrum Protect by using the IBM Installation Manager
installation wizard.

Procedure
1. Start the Installation Manager.
Open the Installation Manager from the Start menu.
2. Click Uninstall.
3. Select IBM Spectrum Protect server, and click Next.
4. Click Uninstall.
5. Click Finish.

© Copyright IBM Corp. 1993, 2017 103

Uninstalling IBM Spectrum Protect

Uninstalling IBM Spectrum Protect in console mode

To uninstall IBM Spectrum Protect by using the command line, you must run the
uninstallation program of IBM Installation Manager from the command line with
the parameter for console mode.

Procedure
1. In the directory where IBM Installation Manager is installed, go to the
following subdirectory:
eclipse\tools
For example:
C:\Program Files\IBM\Installation Manager\eclipse\tools
2. From the tools directory, issue the following command:
imcl.exe -c
3. To uninstall, enter 5.
4. Choose to uninstall from the IBM Spectrum Protect package group.
5. Enter N for Next.
6. Choose to uninstall the IBM Spectrum Protect server package.
7. Enter N for Next.
8. Enter U for Uninstall.
9. Enter F for Finish.

Uninstalling IBM Spectrum Protect in silent mode

To uninstall IBM Spectrum Protect in silent mode, you must run the uninstallation
program of IBM Installation Manager from the command line with the parameters
for silent mode.

Before you begin

You can use a response file to provide data input to silently uninstall the IBM
Spectrum Protect server components. IBM Spectrum Protect includes a sample
response file, uninstall_response_sample.xml, in the input directory where the
installation package is extracted. This file contains default values to help you avoid
any unnecessary warnings.

If you want to uninstall all IBM Spectrum Protect components, leave

modify="false" set for each component in the response file. If you do not want to
uninstall a component, set the value to modify="true".

If you want to customize the response file, you can modify the options that are in
the file. For information about response files, see Response files.

Procedure
1. In the directory where IBM Installation Manager is installed, go to the
following subdirectory:
eclipse\tools
For example:
C:\Program Files\IBM\Installation Manager\eclipse\tools
2. From the tools directory, issue the following command, where response_file
represents the response file path, including the file name:

104 IBM Spectrum Protect for Windows: Installation Guide

 Uninstalling IBM Spectrum Protect

imcl.exe -input response_file -silent

The following command is an example:
imcl.exe -input C:\tmp\input\uninstall_response.xml -silent

Uninstalling and reinstalling IBM Spectrum Protect

If you plan to manually reinstall IBM Spectrum Protect instead of using the
wizard, there are a number of steps to take to preserve your server instance names
and database directories. During an uninstallation, any server instances previously
set up are removed, but the database catalogs for those instances still exist.

About this task

To manually uninstall and reinstall IBM Spectrum Protect, complete the following
steps:
1. Make a list of your current server instances before proceeding to the
uninstallation. Run the following command:
db2ilist
2. Run the following commands for every server instance:
db2 attach to server1
db2 get dbm cfg show detail
db2 detach

Keep a record of the database path for each instance.

3. Uninstall IBM Spectrum Protect. See Chapter 8, “Uninstalling IBM Spectrum
Protect,” on page 103.
After uninstalling IBM Spectrum Protect, check the Control Panel > Add or
Remove Programs to verify that IBM Spectrum Protect DB2 is uninstalled.
4. When you uninstall any supported version of IBM Spectrum Protect, including
a fix pack, an instance file is created. The instance file is created to help
reinstall IBM Spectrum Protect. Check this file and use the information when
you are prompted for the instance credentials when reinstalling. In silent
installation mode, you provide these credentials using the INSTANCE_CRED
variable.
You can find the instance file in the following location:
C:\ProgramData\IBM\Tivoli\TSM\instanceList.obj in the IBM Spectrum
Protect server installation directory
5. Reinstall IBM Spectrum Protect. See Chapter 2, “Installing the server
components,” on page 45.
If the instanceList.obj file does not exist, you need to recreate your server
instances using the following steps:
a. Recreate your server instances. See “Creating the server instance” on page
56.

Tip: The installation wizard configures the server instances but you must
verify that they exist. If they do not exist, you must manually configure
them.
b. Catalog the database. Log in to each server instance as the instance user,
one at a time, and issue the following commands:

Chapter 8. Uninstalling IBM Spectrum Protect 105

Uninstalling IBM Spectrum Protect

set db2instance=server1
db2 catalog database tsmdb1
db2 attach to server1
db2 update dbm cfg using dftdbpath instance_drive
db2 detach
c. Verify that IBM Spectrum Protect recognizes the server instance by listing
your directories. Your home directory appears if you did not change it. Your
instance directory does appear if you used the configuration wizard. Issue
this command:
db2 list database directory

If you see TSMDB1 listed, you can start the server.

Uninstalling IBM Installation Manager

You can uninstall IBM Installation Manager if you no longer have any products
that were installed by IBM Installation Manager.

Before you begin

Before you uninstall IBM Installation Manager, you must ensure that all packages
that were installed by IBM Installation Manager are uninstalled. Close IBM
Installation Manager before you start the uninstall process.

To view installed packages, click Start > All Programs > IBM Installation
Manager > View Installed Packages.

Procedure
To uninstall IBM Installation Manager, complete the following steps:
1. From the Start menu, click Control Panel > Programs and Features.
2. Select IBM Installation Manager and click Uninstall.

106 IBM Spectrum Protect for Windows: Installation Guide

Part 2. Installing and upgrading the Operations Center
The IBM Spectrum Protect Operations Center is the web-based interface for
managing your storage environment.

Before you begin

Before you install and configure the Operations Center, review the following
information:
v “System requirements for the Operations Center” on page 109
– “Operations Center computer requirements” on page 110
– “Hub and spoke server requirements” on page 110
– “Operating system requirements” on page 113
– “Web browser requirements” on page 114
– “Language requirements” on page 114
– “Requirements and limitations for IBM Spectrum Protect client management
services” on page 115
v “Administrator IDs that the Operations Center requires” on page 116
v “IBM Installation Manager” on page 117
v “Installation checklist” on page 118
v “Obtaining the Operations Center installation package” on page 121

About this task

Table 15 lists the methods for installing or uninstalling the Operations Center and
indicates where to find the associated instructions.

For information about upgrading the Operations Center, see Chapter 11,
“Upgrading the Operations Center,” on page 125.
Table 15. Methods for installing or uninstalling the Operations Center
Method Instructions
Graphical wizard v “Installing the Operations Center by using a graphical
wizard” on page 121
v “Uninstalling the Operations Center by using a graphical
wizard” on page 159
Console mode v “Installing the Operations Center in console mode” on page
122
v “Uninstalling the Operations Center in console mode” on
page 159
Silent mode v “Installing the Operations Center in silent mode” on page 122
v “Uninstalling the Operations Center in silent mode” on page
160

© Copyright IBM Corp. 1993, 2017 107

108 IBM Spectrum Protect for Windows: Installation Guide
Chapter 9. Planning to install the Operations Center
Before you install the Operations Center, you must understand the system
requirements, the administrator IDs that the Operations Center requires, and the
information that you must provide to the installation program.

About this task

From the Operations Center, you can manage the following primary aspects of the
storage environment:
v IBM Spectrum Protect servers and clients
v Services such as backup and restore, archive and retrieve, and migrate and recall
v Storage pools and storage devices

The Operations Center includes the following features:

User interface for multiple servers
You can use the Operations Center to manage one or more IBM Spectrum
Protect servers.
In an environment with multiple servers, you can designate one server as a
hub server and the others as spoke servers. The hub server can receive alerts
and status information from the spoke servers and present the information
in a consolidated view in the Operations Center.
Alert monitoring
An alert is a notification of a relevant problem on the server and is
triggered by a server message. You can define which server messages
trigger alerts, and only those messages are reported as alerts in the
Operations Center or in an email.
This alert monitoring can help you identify and track relevant problems on
the server.
Convenient command-line interface
The Operations Center includes a command-line interface for advanced
features and configuration.

System requirements for the Operations Center

Before you install the Operations Center, ensure that your system meets the
minimum requirements.

Use the Operations Center System Requirements Calculator to estimate the system
requirements for running the Operations Center and the hub and spoke servers
that are monitored by the Operations Center.

Requirements that are verified during the installation

Table 16 on page 110 lists the prerequisite requirements that are verified during the
installation and indicates where to find more information about these
requirements.

© Copyright IBM Corp. 1993, 2017 109

 Planning to install the Operations Center

Table 16. Requirements that are verified during the installation

Requirement Details
Minimum memory requirement “Operations Center computer requirements”
Operating system requirement “Operating system requirements” on page
113
Host name for the computer where the “Installation checklist” on page 118
Operations Center will be installed
Requirements for the Operations Center “Installation checklist” on page 118
installation directory

Operations Center computer requirements

You can install the Operations Center on a computer that is also running IBM
Spectrum Protect server or on a different computer. If you install the Operations
Center on the same computer as a server, that computer must meet the system
requirements for both the Operations Center and the server.

Resource requirements

The following resources are required to run the Operations Center:

v One processor core
v 4 GB of memory
v 1 GB of disk space

The hub and spoke servers that are monitored by the Operations Center require
additional resources, as described in “Hub and spoke server requirements.”

Hub and spoke server requirements

When you open the Operations Center for the first time, you must associate the
Operations Center with one IBM Spectrum Protect server that is designated as the
hub server. In a multiple-server environment, you can connect the other servers,
called spoke servers, to the hub server.

The spoke servers send alerts and status information to the hub server. The
Operations Center shows you a consolidated view of alerts and status information
for the hub server and any spoke servers.

If only one server is monitored by the Operations Center, that server is still called
a hub server, even though no spoke servers are connected to it.

Table 17 indicates the version of IBM Spectrum Protect server that must be
installed on the hub server and on each spoke server that is managed by the
Operations Center.
| Table 17. IBM Spectrum Protect server version requirements for hub and spoke servers
| Operations Center Version on the hub server Version on each spoke server
| V8.1.2 V8.1.2 V6.3.4 or later

| Restriction: Some Operations

| Center functions are not
| available for servers that use a
| version earlier than V8.1.2.
|

110 IBM Spectrum Protect for Windows: Installation Guide

 Planning to install the Operations Center

Number of spoke servers that a hub server can support

The number of spoke servers that a hub server can support depends on the
configuration and on the version of IBM Spectrum Protect on each spoke server.
However, a general guideline is that a hub server can support 10 - 20 V6.3.4 spoke
servers but can support more V7.1 or later spoke servers.

Tips for designing the hub and spoke server configuration

In designing the hub and spoke configuration, especially consider the resource
requirements for status monitoring. Also, consider how you want to group hub
and spoke servers and whether you want to use multiple hub servers.

Use the Operations Center System Requirements Calculator to estimate the system
requirements for running the Operations Center and the hub and spoke servers
that are monitored by the Operations Center.

Primary factors that affect performance

The following factors have the most significant impact on the performance of the
Operations Center:
v The processor and memory on the computer where the Operations Center is
installed
v The system resources of the hub and spoke servers, including the disk system
that is in use for the hub server database
v The number of client nodes and virtual machine file spaces that are managed by
the hub and spoke servers
v The frequency at which data is refreshed in the Operations Center

How to group hub and spoke servers

Consider grouping hub and spoke servers by geographic location. For example,
managing the servers within the same data center can help prevent issues that are
caused by firewalls or by inadequate network bandwidth between different
locations. If necessary, you can further divide servers according to one or more of
the following characteristics:
v The administrator who manages the servers
v The organizational entity that funds the servers
v Server operating system
v The language in which the servers run

Tip: If the hub and spoke servers are not running in the same language, you
might see corrupted text in the Operations Center.

How to group hub and spoke servers in an enterprise configuration

In an enterprise configuration, a network of IBM Spectrum Protect servers are

managed as a group. Changes that are made on the configuration manager can be
distributed automatically to one or more managed servers in the network.

The Operations Center normally registers and maintains a dedicated administrator

ID on the hub and spoke servers. This monitoring administrator must always have
the same password on all the servers.

Chapter 9. Planning to install the Operations Center 111

Planning to install the Operations Center

If you use an enterprise configuration, you can improve the process by which the
administrator credentials are synchronized on spoke servers. To improve the
performance and efficiency of maintaining the monitoring administrator ID,
complete the following steps:
1. Designate the configuration manager server as the Operations Center hub
server. During the hub server configuration, a monitoring administrator ID
named IBM-OC-hub_server_name is registered.
2. On the hub server, add the monitoring administrator ID to a new or existing
enterprise configuration profile. Issue the NOTIFY SUBSCRIBERS command to
distribute the profile to the managed servers.
3. Add one or more of the managed servers as Operations Center spoke servers.

The Operations Center detects this configuration and allows the configuration
manager to distribute and update the monitoring administrator ID on the spoke
servers.

When to use multiple hub servers

If you have more than 10 - 20 V6.3.4 spoke servers, or if resource limitations

require the environment to be partitioned, you can configure multiple hub servers,
and connect a subset of the spoke servers to each hub server.

Restrictions:
v A single server cannot be both a hub server and a spoke server.
v Each spoke server can be assigned to only one hub server.
v Each hub server requires a separate instance of the Operations Center, each of
which has a separate web address.

Tips for choosing a hub server

For the hub server, you must choose a server that has adequate resources and is
located for minimal roundtrip network latency.

Attention: Do not use the same server as the hub server for multiple Operations
Centers.

Use the following guidelines in deciding which server to designate as the hub
server:
Choose a lightly loaded server
Consider a server that has a light load for operations such as client backup
and archive. A lightly loaded server is also a good choice as the host
system for the Operations Center.
Ensure that the server has the resources to handle both its typical server
workload and the estimated workload for acting as the hub server.
Locate the server for minimal roundtrip network latency
Locate the hub server so that the network connection between the hub
server and the spoke servers has a roundtrip latency that is no greater than
5 ms. This latency can typically be achieved when the servers are on the
same local area network (LAN).
Networks that are poorly tuned, are heavily used by other applications, or
have roundtrip latency much higher than 5 ms can degrade
communications between the hub and spoke servers. For example,
roundtrip latencies of 50 ms or higher can result in communication
timeouts that cause spoke servers to disconnect or reconnect to the
112 IBM Spectrum Protect for Windows: Installation Guide
 Planning to install the Operations Center

Operations Center. Such high latencies might be experienced in

long-distance, wide area network (WAN) communications.
If spoke servers are a long distance from the hub server and experience
frequent disconnects in the Operations Center, you can increase the value
of the ADMINCOMMTIMEOUT option on each server to reduce the problem.
Verify that the hub server meets the resource requirements for status monitoring
Status monitoring requires extra resources on each server on which it is
enabled. The resources that are required depend primarily on the number
of clients that are managed by the hub and spoke servers. Fewer resources
are used on a hub server with a V7.1 or later spoke server than on a hub
server with a V6.3.4 spoke server.
Verify that the hub server meets the resource requirements for processor
usage, database space, archive log space, and I/O operations per second
(IOPS) capacity.
A hub server with high IOPS capacity can handle a larger amount of
incoming status data from spoke servers. Use of the following storage
devices for the hub server database can help meet this capacity:
v An enterprise-level solid-state drive (SSD)
v An external SAN disk storage device with multiple volumes or multiple
spindles under each volume
In an environment with fewer than 1000 clients, consider establishing a
baseline capacity of 1000 IOPS for the hub server database if the hub
server manages any spoke servers.
Determine whether your environment requires multiple hub servers
If more than 10,000 - 20,000 client nodes and virtual machine file spaces
are managed by one set of hub and spoke servers, the resource
requirements might exceed what the hub server has available, especially if
the spoke servers are V6.3.4 servers. Consider designating a second server
as a hub server and moving spoke servers to the new hub server to
balance the load.

Operating system requirements

The Operations Center is available for AIX, Linux, and Windows systems.

You can run the Operations Center on the following systems:

v Windows systems:
– Microsoft Windows Server 2012: Standard, Enterprise, or Datacenter Edition
(64-bit)
– Microsoft Windows Server 2012 R2 (64-bit)
| – Microsoft Windows Server 2016

For the most up-to-date requirements information, see Software and Hardware
Requirements.

Chapter 9. Planning to install the Operations Center 113

Planning to install the Operations Center

Web browser requirements

The Operations Center can run in Apple, Google, Microsoft, and Mozilla web
browsers.

For optimal viewing of the Operations Center in the web browser, ensure that the
screen resolution for the system is set to a minimum of 1024 X 768 pixels.

For optimal performance, use a web browser that has good JavaScript
performance, and enable browser caching.

The Operations Center can run in the following web browsers:

v Apple Safari on the iPad

Restriction: If Apple Safari is running on iOS 8.x or iOS 9.x, you cannot use a
self-signed certificate for secure communication with the Operations Center
without extra configuration of the certificate. Use a certificate authority (CA)
certificate, or configure the self-signed certificate as needed. For instructions, see
Technote http://www.ibm.com/support/docview.wss?uid=swg21963153.
v Google Chrome 40 or later
v Microsoft Internet Explorer 11 or later
v Mozilla Firefox ESR 31 or later

To run the Operations Center in compliance with the National Institute of

Standards and Technology (NIST) Special Publications (SP) 800-131A
recommendation, communication between the Operations Center and the web
browser must be secured by using the Transport Layer Security (TLS) 1.2 protocol.
During installation, you specify whether SP 800-131A compliance is required and
the level of compliance. If strict SP 800-131A compliance is specified during
installation, the web browser must support TLS 1.2, and TLS 1.2 must be enabled.

The web browser displays an SSL error if strict SP 800-131A compliance is specified
during installation, and the web browser does not meet the preceding
requirements.

Language requirements
By default, the Operations Center uses the language that the web browser uses.
However, the installation process uses the language that the operating system uses.
Verify that the web browser and the operating system are set to the language that
you require.
Table 18. Operations Center language values that you can use on Windows systems
Language Language option value
Chinese, Simplified chs
Chinese, Traditional cht
English ameng
French fra
German deu
Italian ita
Japanese (Shift-JIS) jpn
Korean kor
Portuguese, Brazilian ptb

114 IBM Spectrum Protect for Windows: Installation Guide

 Planning to install the Operations Center

Table 18. Operations Center language values that you can use on Windows
systems (continued)
Language Language option value
Russian rus
Spanish esp

Requirements and limitations for IBM Spectrum Protect client

management services
IBM Spectrum Protect client management services is a component that you install
on backup-archive clients to collect diagnostic information such as client log files.
Before you install the client management service on your system, you must
understand the requirements and limitations.

In the documentation for the client management service, client system is the system
where the backup-archive client is installed.

Diagnostic information can be collected only from Linux and Windows clients, but
administrators can view the diagnostic information in the Operations Center on
AIX, Linux, or Windows operating systems.

Requirements for the client management service

Verify the following requirements before you install the client management service:
v To remotely access the client, the Operations Center administrator must have
system authority or one of the following client authority levels:
– Policy authority
– Client owner authority
– Client node access authority
v Ensure that the client system meets the following requirements:
– The client management service can be installed only on client systems that
run on Linux or Windows operating systems:
- Linux x86 64-bit operating systems that are supported for the
backup-archive client.
- Windows 32-bit and 64-bit operating systems that are supported for the
backup-archive client.
– Transport Layer Security (TLS) 1.2 must be installed for transmission of data
between the client management service and Operations Center. Basic
authentication is provided and data and authentication information are
encrypted through the SSL channel. TLS 1.2 is automatically installed along
with the necessary SSL certificates when you install the client management
service.
v On Linux client systems, you must have root user authority to install the client
management service.
v For client systems that can have multiple client nodes, such as Linux client
systems, ensure that each node name is unique on the client system.

Tip: After you install the client management service, you do not have to install
it again because the service can discover multiple client options files.

Chapter 9. Planning to install the Operations Center 115

Planning to install the Operations Center

Limitations of the client management service

The client management service provides basic services for collecting diagnostic
information from backup-archive clients. The following limitations exist for the
client management service:
v You can install the client management service only on systems with
backup-archive clients, including backup-archive clients that are installed on
data mover nodes for IBM Spectrum Protect for Virtual Environments: Data
Protection for VMware.
v You cannot install the client management service on other IBM Spectrum Protect
client components or products that do not have backup-archive clients.
v If the backup-archive clients are protected by a firewall, ensure that the
Operations Center can connect to the backup-archive clients through the firewall
by using the configured port for the client management service. The default port
is 9028, but it can be changed.
v The client management service scans all client log files to locate entries for the
previous 72-hour period.
v The Diagnosis page in the Operations Center provides basic troubleshooting
information for backup-archive clients. However, for some backup issues, you
might have to access the client system and obtain further diagnostic information.
v If the combined size of the client error log files and schedule log files on a client
system is more than 500 MB, delays can occur in sending log records to the
Operations Center. You can control the size of the log files by enabling log file
pruning or wrapping by specifying the errorlogretention or errorlogmax client
option.
v If you use the same client node name to connect to multiple IBM Spectrum
Protect servers that are installed on the same server, you can view log files for
only one of the client nodes.

For updates about the client management service, including requirements,

limitations, and documentation updates, see technote 1963610.
Related tasks:
“Collecting diagnostic information with IBM Spectrum Protect client management
services” on page 139

Administrator IDs that the Operations Center requires

An administrator must have a valid ID and password on the hub server to log in
to the Operations Center. An administrator ID is also assigned to the Operations
Center so that the Operations Center can monitor servers.

The Operations Center requires the following IBM Spectrum Protect administrator
IDs:
Administrator IDs that are registered on the hub server
Any administrator ID that is registered on the hub server can be used to
log in to the Operations Center. The authority level of the ID determines
which tasks can be completed. You can create new administrator IDs by
using the REGISTER ADMIN command.

Restriction: To use an administrator ID in a multiple-server configuration,

the ID must be registered on the hub and spoke servers with the same
password and authority level.

116 IBM Spectrum Protect for Windows: Installation Guide

 Planning to install the Operations Center

To manage authentication for these servers, consider using one of the

following methods:
v A Lightweight Directory Access Protocol (LDAP) server
v The enterprise configuration functions to automatically distribute
changes to the administrator definitions.
Monitoring administrator ID
When you initially configure the hub server, an administrator ID named
IBM-OC-server_name is registered with system authority on the hub server
and is associated with the initial password that you specify. This ID, which
is sometimes called the monitoring administrator, is intended for use only by
the Operations Center.
Do not delete, lock, or modify this ID. The same administrator ID with the
same password is registered on the spoke servers that you add. The
password is automatically changed on the hub and spoke servers every 90
days. You do not need to use or manage this password.

Restriction: The Operations Center maintains the monitoring

administrator ID and password on spoke servers unless you use an
enterprise configuration to manage these credentials. For more information
about using an enterprise configuration to manage the credentials, see
“Tips for designing the hub and spoke server configuration” on page 111.

IBM Installation Manager

The Operations Center uses IBM Installation Manager, which is an installation
program that can use remote or local software repositories to install or update
many IBM products.

If the required version of IBM Installation Manager is not already installed, it is

automatically installed or upgraded when you install the Operations Center. It
must remain installed on the system so that the Operations Center can be updated
or uninstalled later as needed.

The following list contains explanations of some terms that are used in IBM
Installation Manager:
Offering
An installable unit of a software product.
The Operations Center offering contains all of the media that IBM
Installation Manager requires to install the Operations Center.
Package
The group of software components that are required to install an offering.
The Operations Center package contains the following components:
v IBM Installation Manager installation program
v Operations Center offering
Package group
A set of packages that share a common parent directory.
Repository
A remote or local storage area for data and other application resources.
The Operations Center package is stored in a repository on IBM Fix
Central.

Chapter 9. Planning to install the Operations Center 117

Planning to install the Operations Center

Shared resources directory

A directory that contains software files or plug-ins that are shared by
packages.
IBM Installation Manager stores installation-related files in the shared
resources directory, including files that are used for rolling back to a
previous version of the Operations Center.

Installation checklist
Before you install the Operations Center, you must verify certain information, such
as the installation credentials, and you must determine the input to provide to IBM
Installation Manager for the installation.

The following checklist highlights the information that you must verify or
determine before you install the Operations Center, and Table 19 describes the
details of this information:
__ Verify the host name for the computer where the Operations Center is to be
installed.
__ Verify the installation credentials.
__ Determine the Operations Center installation directory, if you do not want to
accept the default path.
__ Determine the IBM Installation Manager installation directory, if you do not
want to accept the default path.
__ Determine the port number to be used by the Operations Center web server,
if you do not want to accept the default port number.
__ Determine the password for secure communications.
__ Determine whether secure communications must comply with the National
Institute of Standards and Technology (NIST) Special Publications (SP)
800-131A recommendation.
Table 19. Information to verify or determine before you install the Operations Center
Information Details
Host name for the computer The host name must meet the following criteria:
where the Operations Center v It must not contain double-byte character set (DBCS) characters or the underscore
is to be installed. character (_).
v Although the host name can contain the hyphen character (-), it cannot have a
hyphen as the last character in the name.
Installation credentials To install the Operations Center, you must use the following user account:
v Administrator

118 IBM Spectrum Protect for Windows: Installation Guide

 Planning to install the Operations Center

Table 19. Information to verify or determine before you install the Operations Center (continued)
Information Details
Operations Center installation The Operations Center is installed in the ui subdirectory of the installation directory.
directory
The following path is the default path for the Operations Center installation
directory:
v c:\Program Files\Tivoli\TSM
For example, if you use this default path, the Operations Center is installed in the
following directory:
c:\Program Files\Tivoli\TSM\ui

The installation directory path must meet the following criteria:

v The path must contain no more than 128 characters.
v The path must include only ASCII characters.
v The path cannot include non-displayable control characters.
v The path cannot include any of the following characters:
% | < > ’ " $ & ; *

IBM Installation Manager The following path is the default path for the IBM Installation Manager installation
installation directory directory:
v C:\Program Files\IBM\Installation Manager
Port number that is used by The value for the secure (https) port number must meet the following criteria:
the Operations Center web v The number must be an integer in the range 1024 - 65535.
server.
v The number cannot be in use or allocated to other programs.

If you do not specify a port number, the default value is 11090.

Tip: If you later do not remember the port number that you specified, refer to the
following file, where installation_dir represents the directory where the
Operations Center is installed:
v installation_dir\ui\Liberty\usr\servers\guiServer\bootstrap.properties

The bootstrap.properties file contains the IBM Spectrum Protect server connection
information.

Chapter 9. Planning to install the Operations Center 119

 Planning to install the Operations Center

Table 19. Information to verify or determine before you install the Operations Center (continued)
Information Details
Password for secure The Operations Center uses Hypertext Transfer Protocol Secure (HTTPS) to
communications communicate with web browsers.

| The Operations Center requires secure communication between the server and the
| Operations Center. To secure communication, you must add the Transport Layer
| Security (TLS) certificate of the hub server to the truststore file of the Operations
| Center.

| The truststore file of the Operations Center contains the certificate that the
| Operations Center uses for HTTPS communication with web browsers. During
| installation of the Operations Center, you create a password for the truststore file.
| When you set up secure communication between the Operations Center and the hub
| server, you must use the same password to add the certificate of the hub server to
| the truststore file.

The password for the truststore file must meet the following criteria:
v The password must contain a minimum of 6 characters and a maximum of 64
characters.
v The password must contain at least the following characters:
– One uppercase letter (A – Z)
– One lowercase letter (a – z)
– One digit (0 – 9)
– Two of the non-alphanumeric characters that are listed in the following series:
~ ! @ # $ % ^ & * _ - + = ` |
( ) { } [ ] : ; < > , . ? /

Related tasks:
“Configuring for secure communication” on page 133
“Resetting the password for the Operations Center truststore file” on page 136

120 IBM Spectrum Protect for Windows: Installation Guide

Chapter 10. Installing the Operations Center
You can install the Operations Center by using any of the following methods: a
graphical wizard, the command line in console mode, or silent mode.

Before you begin

You cannot configure the Operations Center until you install, configure, and start
the IBM Spectrum Protect server. Therefore, before you install the Operations
Center, install the appropriate server package, according to the server version
requirements in “Hub and spoke server requirements” on page 110.

You can install the Operations Center on a computer with the IBM Spectrum
Protect server or on a separate computer.

Obtaining the Operations Center installation package

You can obtain the installation package from an IBM download site such as IBM
Passport Advantage or IBM Fix Central.

About this task

After you obtain the package from an IBM download site, you must extract the
installation files.

Procedure
Complete the following steps to extract the Operations Center installation files. In
the following steps, replace version_number with the version of Operations Center
that you are installing.
On Windows systems:
1. Download the following package file to the directory of your choice:
version_number.000-IBM-SPOC-WindowsX64.exe
2. In Windows Explorer, double-click the file name to extract the installation files.
The self-extracting package file is extracted to the directory.

Installing the Operations Center by using a graphical wizard

You can install or update the Operations Center by using the graphical wizard of
IBM Installation Manager.

Procedure
1. From the directory where the Operations Center installation package file is
extracted, issue the following command:
install.bat
2. Follow the wizard instructions to install the IBM Installation Manager and
Operations Center packages.

What to do next

See “Configuring the Operations Center” on page 127.

© Copyright IBM Corp. 1993, 2017 121

Installing the Operations Center

Installing the Operations Center in console mode

You can install or update the Operations Center by using the command line in
console mode.

Procedure
1. From the directory where the installation package file is extracted, run the
following program:
install.bat -c
2. Follow the console instructions to install the Installation Manager and
Operations Center packages.

What to do next

See “Configuring the Operations Center” on page 127.

Installing the Operations Center in silent mode

You can install or upgrade the Operations Center in silent mode. In silent mode,
the installation does not send messages to a console but instead stores messages
and errors in log files.

Before you begin

To provide data input when you use the silent installation method, you can use a
response file. The following sample response files are provided in the input
directory where the installation package is extracted:
install_response_sample.xml
Use this file to install the Operations Center.
update_response_sample.xml
Use this file to upgrade the Operations Center.

These files contain default values that can help you avoid any unnecessary
warnings. To use these files, follow the instructions that are provided in the files.

If you want to customize a response file, you can modify the options that are in
the file. For information about response files, see Response files.

Procedure
1. Create a response file. You can modify the sample response file or create your
own file.

Tip: To generate a response file as part of a console-mode installation, complete

the selection of the console-mode installation options. Then, in the Summary
panel, enter G to generate the response file according to the previously selected
options.
2. Create a password for the Operations Center truststore in the response file.
If you are using the install_response_sample.xml file, add the password in the
following line of the file, where mypassword represents the password:
<variable name=’ssl.password’ value=’mypassword’ />

For more information about this password, see “Installation checklist” on page
118.

122 IBM Spectrum Protect for Windows: Installation Guide

 Installing the Operations Center

Tip: To upgrade the Operations Center, the truststore password is not required
if you are using the update_response_sample.xml file.
3. Start the silent installation by issuing the following command from the
directory where the installation package is extracted. The value response_file
represents the response file path and file name:
v
install.bat -s -input response_file -acceptLicense

What to do next

See “Configuring the Operations Center” on page 127.

Chapter 10. Installing the Operations Center 123

124 IBM Spectrum Protect for Windows: Installation Guide
Chapter 11. Upgrading the Operations Center
You can upgrade the Operations Center by using any of the following methods: a
graphical wizard, the command line in console mode, or silent mode.

Before you begin

Before you upgrade the Operations Center, review the system requirements and
the installation checklist. The new version of the Operations Center might have
more or different requirements and considerations than the version you are
currently using.

About this task

The instructions for upgrading the Operations Center are the same as the
instructions for installing the Operations Center, with the following exceptions:
v You use the Update function of IBM Installation Manager rather than the Install
function.

Tip: In IBM Installation Manager, the term update means to discover and install
updates and fixes to installed software packages. In this context, update and
upgrade are synonymous.
v If you are upgrading the Operations Center in silent mode, you can skip the
step of creating a password for the truststore file.

© Copyright IBM Corp. 1993, 2017 125

Upgrading the Operations Center

126 IBM Spectrum Protect for Windows: Installation Guide

Chapter 12. Getting started with the Operations Center
Before you can use the Operations Center to manage your storage environment,
you must configure it.

About this task

After you install the Operations Center, complete the following basic configuration
steps:
1. Designate the hub server.
2. Add any spoke servers.
3. Optionally, configure email alerts on the hub and spoke servers.

Figure 1 illustrates an Operations Center configuration.

Spoke server

Hub server
Spoke server

Operations Center
(on hub server computer
or separate computer)
Spoke server

Spoke server

Figure 1. Example of an Operations Center configuration with the hub and spoke servers

Configuring the Operations Center

When you open the Operations Center for the first time, you must configure it to
manage your storage environment. You must associate the Operations Center with
the IBM Spectrum Protect server that is designated as the hub server. You can then
connect additional IBM Spectrum Protect servers as spoke servers.

© Copyright IBM Corp. 1993, 2017 127

 Getting started with the Operations Center

Designating the hub server

When you connect to the Operations Center for the first time, you must designate
which IBM Spectrum Protect server is the hub server.

| Before you begin

| The Operations Center requires secure communication between the hub server and
| the Operations Center. To secure communication, you must add the Transport
| Layer Security (TLS) certificate of the hub server to the truststore file of the
| Operations Center. For more information, see “Securing communication between
| the Operations Center and the hub server” on page 133.

Procedure

In a web browser, enter the following address, where hostname represents the name
of the computer where the Operations Center is installed, and secure_port
represents the port number that the Operations Center uses for HTTPS
communication on that computer:
https://hostname:secure_port/oc

Tips:
v The URL is case-sensitive. For example, ensure that you type “oc” in lowercase
as indicated.
v For more information about the port number, see the Installation checklist.
v If you are connecting to the Operations Center for the first time, you must
provide the following information:
– Connection information for the server that you want to designate as a hub
server
– Login credentials for an administrator ID that is defined for that server
v If the event-record retention period of the server is less than 14 days, the period
is automatically reset to 14 days if you configure the server as a hub server.

What to do next

If you have multiple IBM Spectrum Protect servers in your environment, add the
other servers as spoke servers to the hub server.

Attention: Do not change the name of a server after it is configured as a hub or

spoke server.
Related concepts:
“Hub and spoke server requirements” on page 110
“Administrator IDs that the Operations Center requires” on page 116

128 IBM Spectrum Protect for Windows: Installation Guide

 Getting started with the Operations Center

Adding a spoke server

After you configure the hub server for the Operations Center, you can add one or
more spoke servers to the hub server.

| Before you begin

| Communication between the spoke server and the hub server must be secured by
| using the Transport Layer Security (TLS) protocol. To secure communication, add
| the certificate of the spoke server to the truststore file of the hub server.

Procedure
1. In the Operations Center menu bar, click Servers. The Servers page opens.
In the table on the Servers page, a server might have a status of
“Unmonitored.” This status means that although an administrator defined this
server to the hub server by using the DEFINE SERVER command, the server is
not yet configured as a spoke server.
2. Complete one of the following steps:
v Click the server to highlight it, and in the table menu bar, click Monitor
Spoke.
v If the server that you want to add is not shown in the table, and secure
SSL/TLS communication is not required, click + Spoke in the table menu
bar.
3. Provide the necessary information, and complete the steps in the spoke
configuration wizard.

Tip: If the event-record retention period of the server is less than 14 days, the
period is automatically reset to 14 days if you configure the server as a spoke
server.

Sending email alerts to administrators

An alert is a notification of a relevant problem on the IBM Spectrum Protect server
and is triggered by a server message. Alerts can be shown in the Operations
Center and can be sent from the server to administrators by email.

Before you begin

Before you configure email notification for administrators about alerts, ensure that
the following requirements are met:
v An SMTP server is required to send and receive alerts by email, and the server
that sends the alerts by email must have access to the SMTP server.

Tip: If the Operations Center is installed on a separate computer, that computer

does not need access to the SMTP server.
v An administrator must have system privilege to configure email notification.

About this task

An email notification is sent only for the first occurrence of an alert. Also, if an
alert is generated before you configure email notification, no email notification is
sent for that alert.

You can configure email notification in the following ways:

v Send notification for individual alerts

Chapter 12. Getting started with the Operations Center 129

Getting started with the Operations Center

v Send alert summaries

An alert summary contains information about current alerts. The summary

includes the total number of alerts, the total number of active and inactive alerts,
the oldest alert, the newest alert, and the most frequently occurring alert.

You can specify a maximum of three administrators to receive alert summaries by

email. Alert summaries are sent approximately every hour.

Procedure

To configure email notification for administrators about alerts, complete the

following steps on each hub and spoke server from which you want to receive
email alerts:
1. To verify that alert monitoring is turned on, issue the following command:
QUERY MONITORSETTINGS
2. If the command output indicates that alert monitoring is turned off, issue the
following command. Otherwise, proceed to the next step.
SET ALERTMONITOR ON
3. To enable the sending of email notification, issue the following command:
SET ALERTEMAIL ON
4. To define the SMTP server that is used to send email notification, issue the
following command:
SET ALERTEMAILSMTPHOST host_name
5. To specify the port number for the SMTP server, issue the following command:
SET ALERTEMAILSMTPPORT port_number
The default port number is 25.
6. To specify the email address of the sender of the alerts, issue the following
command:
SET ALERTEMAILFROMADDR email_address
7. For each administrator ID that must receive email notification, issue one of the
following commands to activate email notification and to specify the email
address:
REGISTER ADMIN admin_name ALERT=YES EMAILADDRESS=email_address
UPDATE ADMIN admin_name ALERT=YES EMAILADDRESS=email_address
8. Choose either, or both, of the following options, and specify the administrator
IDs to receive email notification:
v Send notification for individual alerts
To specify or update the administrator IDs to receive email notification for an
individual alert, issue one of the following commands:
DEFINE ALERTTRIGGER message_number ADmin=admin_name1,admin_name2
UPDATE ALERTTRIGGER message_number ADDadmin=admin_name3 DELadmin=admin_name1

Tip: From the Configure Alerts page of the Operations Center, you can select
the administrators who will receive email notification.
v Send alert summaries
To specify or update the administrator IDs to receive alert summaries by
email, issue the following command:
SET ALERTSUMMARYTOADMINS admin_name1,admin_name2,admin_name3
If you want to receive alert summaries but do not want to receive notification
about individual alerts, complete the following steps:

130 IBM Spectrum Protect for Windows: Installation Guide

 Getting started with the Operations Center

a. Suspend notification about individual alerts, as described in “Suspending

email alerts temporarily.”
b. Ensure that the respective administrator ID is listed in the following
command:
SET ALERTSUMMARYTOADMINS admin_name1,admin_name2,admin_name3

Sending email alerts to multiple administrators

The following example illustrates the commands that cause any alerts for message
ANR1075E to be sent in an email to the administrators myadmin, djadmin, and
csadmin:
SET ALERTMONITOR ON
SET ALERTEMAIL ON
SET ALERTEMAILSMTPHOST mymailserver.domain.com
SET ALERTEMAILSMTPPORT 450
SET ALERTEMAILFROMADDR srvadmin@mydomain.com
UPDATE ADMIN myadmin ALERT=YES EMAILADDRESS=myaddr@anycompany.com
UPDATE ADMIN djadmin ALERT=YES EMAILADDRESS=djaddr@anycompany.com
UPDATE ADMIN csadmin ALERT=YES EMAILADDRESS=csaddr@anycompany.com
DEFINE ALERTTRIGGER anr0175e ADMIN=myadmin,djadmin,csadmin

Suspending email alerts temporarily

In certain situations, you might want to suspend email alerts temporarily. For
example, you might want to receive alert summaries but suspend notification
about individual alerts, or you might want to suspend email alerts when an
administrator is on vacation.

Before you begin

Configure email notification for administrators, as described in “Sending email

alerts to administrators” on page 129.

Procedure

Suspend email notification for individual alerts or for alert summaries.

v Suspend notification about individual alerts
Use either of the following methods:
UPDATE ADMIN command
To turn off email notification for the administrator, issue the following
command:
UPDATE ADMIN admin_name ALERT=NO

To turn on email notification again later, issue the following command:

UPDATE ADMIN admin_name ALERT=YES
UPDATE ALERTTRIGGER command
To prevent a specific alert from being sent to an administrator, issue the
following command:
UPDATE ALERTTRIGGER message_number DELADMIN=admin_name

To start sending that alert to the administrator again, issue the following
command:
UPDATE ALERTTRIGGER message_number ADDADMIN=admin_name
v Suspend notification about alert summaries

Chapter 12. Getting started with the Operations Center 131

Getting started with the Operations Center

To prevent alert summaries from being sent to an administrator, remove the

administrator ID from the list in the following command:
SET ALERTSUMMARYTOADMINS admin_name1,admin_name2,admin_name3
If an administrator ID is listed in the preceding command, the administrator
receives alert summaries by email, even if notification about individual alerts is
suspended for the respective administrator ID.

Adding customized text to the login screen

You can add customized text, such as your organization's Terms of Use of the
software, to the login screen of the Operations Center so that users of the
Operations Center see the text before they enter their user name and password.

Procedure

To add customized text to the login screen, complete the following steps:
1. On the computer where the Operations Center is installed, go to the following
directory, where installation_dir represents the directory in which the
Operations Center is installed:
installation_dir\ui\Liberty\usr\servers\guiServer
2. In the directory, create a file that is named loginText.html that contains the
text that you want to add to the login screen. Any special, non-ASCII text must
be UTF-8 encoded.

Tip: You can format the text by adding HTML tags.

3. Review the added text on the login screen of the Operations Center.
To open the Operations Center, enter the following address in a web browser,
where hostname represents the name of the computer where the Operations
Center is installed, and secure_port represents the port number that the
Operations Center uses for HTTPS communication on that computer:
https://hostname:secure_port/oc

Enabling REST services

Applications that use Representational State Transfer (REST) services can query
and manage the storage environment by connecting to the Operations Center.

About this task

Enable this feature to allow REST services to interact with hub and spoke servers
by sending calls to the following address:
https://oc_host_name:port/oc/api

where oc_host_name is the network name or IP address of the Operations Center

host system and port is the Operations Center port number. The default port
number is 11090.

For information about the REST services that are available for the Operations
Center, see Technote http://www.ibm.com/support/
docview.wss?uid=swg21973011, or issue the following REST call:
https://oc_host_name:port/oc/api/help

132 IBM Spectrum Protect for Windows: Installation Guide

 Getting started with the Operations Center

Procedure
1. On the Operations Center menu bar, hover over the settings icon and click
Settings.
2. On the General page, select the Enable administrative REST API check box.
3. Click Save.

Configuring for secure communication

The Operations Center uses Hypertext Transfer Protocol Secure (HTTPS) to
communicate with web browsers. The Transport Layer Security (TLS) protocol
secures communications between the Operations Center and the hub server, and
between the hub server and associated spoke servers.

About this task

| TLS 1.2 is required for secure communication between the IBM Spectrum Protect
| server and the Operations Center, and between the hub server and spoke servers.

Securing communication between the Operations Center and

the hub server
To secure communications between the Operations Center and the hub server, you
must add the Transport Layer Security (TLS) certificate of the hub server to the
truststore file of the Operations Center.

Before you begin

The truststore file of the Operations Center is a container for certificates that the
Operations Center can access. The truststore file contains the certificate that the
Operations Center uses for HTTPS communication with web browsers.

During the installation of the Operations Center, you create a password for the
truststore file. To secure communication between the Operations Center and the
hub server, you must use the same password to add the certificate of the hub
server to the truststore file. If you do not remember this password, you can reset it.
See “Resetting the password for the Operations Center truststore file” on page 136.

Procedure
1. Specify the cert256.arm certificate as the default certificate in the key database
file of the hub server.
To specify cert256.arm as the default certificate, complete the following steps:
a. Issue the following command from the hub server instance directory:
gsk8capicmd_64 -cert -setdefault -db cert.kdb -stashed
-label "TSM Server SelfSigned SHA Key"
b. Restart the hub server so that it can receive the changes to the key database
file.
2. To verify that the cert256.arm certificate is set as the default certificate in the
key database file of the hub server, issue the following command:
gsk8capicmd_64 -cert -list -db cert.kdb -stashed
3. Stop the Operations Center web server.
4. Go to the command line of the operating system on which the Operations
Center is installed.

Chapter 12. Getting started with the Operations Center 133

Getting started with the Operations Center

5. Add the certificate to the truststore file of the Operations Center by using the
iKeycmd command or the iKeyman command. The iKeyman command opens the
IBM Key Management graphical user interface, and iKeycmd is a command line
interface.
To add the SSL certificate by using the command line interface, issue the
iKeycmd command to add the cert256.arm certificate as the default certificate in
the key database file of the hub server:
ikeycmd -cert -add
-db /installation_dir/Liberty/usr/servers/guiServer/gui-truststore.jks
-file /fvt/comfrey/srv/cert256.arm
-label ’label description’
-pw ’password’ -type jks -format ascii -trust enable

where:
installation_dir
The directory in which the Operations Center is installed.
label description
The description that you assign to the label.
password
The password that you created when you installed the Operations Center.
To reset the password, uninstall the Operations Center, delete the .jks file,
and reinstall the Operations Center.
To add the certificate by using the IBM Key Management window, complete the
following steps:
a. Go to the following directory, where installation_dir represents the
directory in which the Operations Center is installed:
v installation_dir\ui\jre\bin
b. Open the IBM Key Management window by issuing the following
command:
ikeyman
c. Click Key Database File > Open.
d. In the Open window, click Browse, and go to the following directory, where
installation_dir represents the directory in which the Operations Center is
installed:
v installation_dir\ui\Liberty\usr\servers\guiServer
e. In the guiServer directory, select the gui-truststore.jks file.
f. Click Open, and click OK.
g. Enter the password for the truststore file, and click OK.
h. In the Key database content area of the IBM Key Management window,
click the arrow, and select Signer Certificates from the list.
i. Click Add.
j. In the Open window, click Browse, and go to the hub server instance
directory, as shown in the following example:
v c:\Program Files\Tivoli\TSM\server1
The directory contains the cert256.arm certificate.
If you cannot access the hub server instance directory from the Open
window, complete the following steps:
1) Use FTP or another file-transfer method to copy the cert256.arm files
from the hub server to the following directory on the computer where
the Operations Center is installed:

134 IBM Spectrum Protect for Windows: Installation Guide

 Getting started with the Operations Center

v installation_dir\ui\Liberty\usr\servers\guiServer
2) In the Open window, go to the guiServer directory.
k. Select the cert256.arm certificate as the certificate.

Tip: The certificate that you choose must be set as the default certificate in
the key database file of the hub server. For more information, see step 1 on
page 133 and 2 on page 133.
l. Click Open, and click OK.
m. Enter a label for the certificate. For example, enter the name of the hub
server.
n. Click OK. The SSL certificate of the hub server is added to the truststore
file, and the label is displayed in the Key database content area of the IBM
Key Management window.
o. Close the IBM Key Management window.
6. Start the Operations Center web server.
7. When you connect to the Operations Center for the first time, you are
prompted to identify the IP address or network name of the hub server, and
the port number for communicating with the hub server. If the
ADMINONCLIENTPORT server option is enabled for the IBM Spectrum
Protect server, enter the port number that is specified by the TCPADMINPORT
server option. If the ADMINONCLIENTPORT server option is not enabled,
enter the port number that is specified by the TCPPORT server option.
If the Operations Center was previously configured, you can review the
contents of the serverConnection.properties file to verify the connection
information. The serverConnection.properties file is in the following directory
on the computer where the Operations Center is installed:
v installation_dir\ui\Liberty\usr\servers\guiServer

What to do next

To set up SSL communication between the hub server and a spoke server, see
“Securing communication between the hub server and a spoke server.”

Securing communication between the hub server and a spoke

server
To secure communications between the hub server and a spoke server by using the
Transport Layer Security (TLS) protocol, you must define the certificate of the
spoke server to the hub server. You must also configure the Operations Center to
monitor the spoke server.

Procedure
1. On the spoke server, change to the directory of the spoke server instance.
2. Specify the required cert256.arm certificate as the default certificate in the key
database file of the spoke server. Issue the following command:
gsk8capicmd_64 -cert -setdefault -db cert.kdb -stashed
-label "TSM Server SelfSigned SHA Key"
3. Verify the certificates in the key database file of the spoke server. Issue the
following command:
gsk8capicmd_64 -cert -list -db cert.kdb -stashed
4. Securely transfer the cert256.arm file of the spoke server to the hub server.
5. On the hub server, change to the directory of the hub server instance.

Chapter 12. Getting started with the Operations Center 135

Getting started with the Operations Center

6. Define the spoke server certificate to the hub server. Issue the following
command from the hub server instance directory, where spoke_servername is
the name of the spoke server, and spoke_cert256.arm is the file name of the
spoke server certificate:
gsk8capicmd_64 -cert -add -db cert.kdb -stashed -format ascii
-label spoke_servername -file spoke_cert256.arm

The spoke server does not require the hub server certificate for hub-to-spoke
communication. However, other server configurations that require
cross-defined servers do require the spoke server to have the hub server
certificate.
7. Restart the hub server and the spoke server.
8. For the hub server, issue the DEFINE SERVER command, according to the
following example:
DEFINE SERVER spoke_servername HLA=spoke_address
LLA=spoke_SSLTCPADMINPort SERVERPA=spoke_serverpassword

Tip: By default, server communication is encrypted except when the server is

sending or receiving object data. Object data is sent and received by using
TCP/IP. By choosing not to encrypt the object data, server performance is
similar to communication over a TCP/IP session and the session is secure. To
encrypt all communication with the specified server, even when the server is
sending and receiving object data, specify the SSL=YES parameter on the
DEFINE SERVER command.
9. On the Operations Center menu bar, click Servers.
In the table on the Servers page, the spoke server that you defined in step 8
typically has a status of "Unmonitored." Depending on the setting for the
status refresh interval, you might not see the spoke server immediately.
10. Click the spoke server to highlight the item, and in the table menu bar, click
Monitor Spoke.

Resetting the password for the Operations Center truststore

file
To set up secure communication between the Operations Center and the hub
server, you must know the password for the truststore file of the Operations
Center. You create this password during the installation of the Operations Center. If
you do not know the password, you can reset it.

About this task

To reset the password, you must create a new password, delete the truststore file
of the Operations Center, and restart the Operations Center web server.

Procedure
1. Stop the Operations Center web server.
2. Go to the following directory, where installation_dir represents the directory
in which the Operations Center is installed:
installation_dir\ui\Liberty\usr\servers\guiServer
3. Open the bootstrap.properties file, which contains the password for the
truststore file. If the password is unencrypted, you can use it to open the
truststore file without having to reset it.
The following examples indicate the difference between an encrypted and an
unencrypted password:

136 IBM Spectrum Protect for Windows: Installation Guide

 Getting started with the Operations Center

Encrypted password example

Encrypted passwords begin with the text string {xor}.
The following example shows the encrypted password as the value of
the tsm.truststore.pswd parameter:
tsm.truststore.pswd={xor}MiYPPiwsKDAtOw==
Unencrypted password example
The following example shows the unencrypted password as the value
of the tsm.truststore.pswd parameter:
tsm.truststore.pswd=J8b%^B
4. Reset the password by replacing the password in the bootstrap.properties file
with a new password. You can replace the password with an encrypted or
unencrypted password. Remember the unencrypted password for future use.
To create an encrypted password, complete the following steps:
a. Create an unencrypted password.
The password for the truststore file must meet the following criteria:
v The password must contain a minimum of 6 characters and a maximum
of 64 characters.
v The password must contain at least the following characters:
– One uppercase letter (A – Z)
– One lowercase letter (a – z)
– One digit (0 – 9)
– Two of the non-alphanumeric characters that are listed in the following
series:
~ ! @ # $ % ^ & * _ - + = ` |
( ) { } [ ] : ; < > , . ? /
b. From the command line of the operating system, go to the following
directory:
installation_dir\ui\Liberty\bin
c. To encrypt the password, issue the following command, where myPassword
represents the unencrypted password:
securityUtility.bat encode myPassword
The following message might be shown:
! "java"’ is not recognized as an internal or external command,
operable program or batch file.

If this message is shown, complete the following steps:

1) Issue the following command, where installation_dir represents the
directory where the Operations Center is installed:
set JAVA_HOME="installation_dir\ui\jre"
2) Reissue the following command to encrypt the password:
securityUtility.bat encode myPassword
5. Close the bootstrap.properties file.
6. Go to the following directory:
installation_dir\ui\Liberty\usr\servers\guiServer
7. Delete the gui-truststore.jks file, which is the truststore file of the Operations
Center.
8. Start the Operations Center web server.

Chapter 12. Getting started with the Operations Center 137

Getting started with the Operations Center

Results

A new truststore file is automatically created for the Operations Center, and the
TLS certificate of the Operations Center is automatically included in the truststore
file.

Starting and stopping the web server

The web server of the Operations Center runs as a service and starts automatically.
You might need to stop and start the web server, for example, to make
configuration changes.

Procedure

Stop and start the web server.

v From the Services window, stop or start the Operations Center service.

Opening the Operations Center

The Overview page is the default initial view in the Operations Center. However,
in your web browser, you can bookmark the page that you want to open when
you log in to the Operations Center.

Procedure
1. In a web browser, enter the following address, where hostname represents the
name of the computer where the Operations Center is installed, and secure_port
represents the port number that the Operations Center uses for HTTPS
communication on that computer:
https://hostname:secure_port/oc

Tips:
v The URL is case-sensitive. For example, ensure that you type “oc” in
lowercase as indicated.
v The default port number for HTTPS communication is 11090, but a different
port number can be specified during Operations Center installation.
2. Log in, using an administrator ID that is registered on the hub server.
In the Overview page, you can view summary information for clients, services,
servers, storage pools, and storage devices. You can view more details by
clicking items or by using the Operations Center menu bar.

Monitoring from a mobile device: To remotely monitor the storage

environment, you can view the Overview page of the Operations Center in the
web browser of a mobile device. The Operations Center supports the Apple
Safari web browser on the iPad. Other mobile devices can also be used.

138 IBM Spectrum Protect for Windows: Installation Guide

 Getting started with the Operations Center

Collecting diagnostic information with IBM Spectrum Protect client

management services
The client management service collects diagnostic information about
backup-archive clients and makes the information available to the Operations
Center for basic monitoring capability.

About this task

After you install the client management service, you can view the Diagnosis page
in the Operations Center to obtain troubleshooting information for backup-archive
clients.

Diagnostic information can be collected only from Linux and Windows clients, but
administrators can view the diagnostic information in the Operations Center on
AIX, Linux, or Windows operating systems.

You can also install the client management service on data mover nodes for IBM
Spectrum Protect for Virtual Environments: Data Protection for VMware to collect
diagnostic information about the data movers.

Tip: In the documentation for the client management service, client system is the
system where the backup-archive client is installed.

Installing the client management service by using a graphical

wizard
To collect diagnostic information about backup-archive clients such as client log
files, you must install the client management service on the client systems that you
manage.

Before you begin

Review “Requirements and limitations for IBM Spectrum Protect client

management services” on page 115.

About this task

You must install the client management service on the same computer as the
backup-archive client.

Procedure
1. Download the installation package for the client management service from an
IBM download site such as IBM Passport Advantage or IBM Fix Central. Look
for a file name that is similar to <version>-IBM-SPCMS-<operating system>.bin.
The following table shows the names of the installation packages.
|| Client operating system Installation package name
| Linux x86 64-bit 8.1.x.000-IBM-SPCMS-Linuxx64.bin
| Windows 32-bit 8.1.x.000-IBM-SPCMS-Windows32.exe
| Windows 64-bit 8.1.x.000-IBM-SPCMS-Windows64.exe
|
2. Create a directory on the client system that you want to manage, and copy the
installation package there.

Chapter 12. Getting started with the Operations Center 139

Getting started with the Operations Center

3. Extract the contents of the installation package file.

v On Linux client systems, complete the following steps:
a. Change the file to an executable file by issuing the following command:
chmod +x 8.1.x.000-IBM-SPCMS-Linuxx64.bin
b. Issue the following command:
./8.1.x.000-IBM-SPCMS-Linuxx64.bin
v On Windows client systems, double-click the installation package name in
Windows Explorer.

Tip: If you previously installed and uninstalled the package, select All when
prompted to replace the existing installation files.
4. Run the installation batch file from the directory where you extracted the
installation files and associated files. This is the directory that you created in
step 2 on page 139.
v On Linux client systems, issue the following command:
./install.sh
v On Windows client systems, double-click install.bat.
5. To install the client management service, follow the instructions in the IBM
Installation Manager wizard.
If IBM Installation Manager is not already installed on the client system, you
must select both IBM Installation Manager and IBM Spectrum Protect Client
Management Services.

Tip: You can accept the default locations for the shared resources directory and
the installation directory for IBM Installation Manager.

What to do next

Follow the instructions in “Verifying that the client management service is installed
correctly” on page 141.

Installing the client management service in silent mode

You can install the client management service in silent mode. When you use silent
mode, you provide the installation values in a response file and then run an
installation command.

Before you begin

Review “Requirements and limitations for IBM Spectrum Protect client

management services” on page 115.

Extract the installation package by following the instructions in “Installing the

client management service by using a graphical wizard” on page 139.

About this task

You must install the client management service on the same computer as the
backup-archive client.

The input directory, which is in the directory where the installation package is
extracted, contains the following sample response file:

install_response_sample.xml

140 IBM Spectrum Protect for Windows: Installation Guide

 Getting started with the Operations Center

You can use the sample file with the default values, or you can customize it.

Tip: If you want to customize the sample file, create a copy of the sample file,
rename it, and edit the copy.

Procedure
1. Create a response file based on the sample file, or use the sample file,
install_response_sample.xml.
In either case, ensure that the response file specifies the port number for the
client management service. The default port is 9028. For example:
<variable name='port' value='9028'/>
2. Run the command to install the client management service and accept the
license. From the directory where the installation package file is extracted, issue
the following command, where response_file represents the response file path,
including the file name:
On a Linux client system:
./install.sh -s -input response_file -acceptLicense
For example:
./install.sh -s -input /cms_install/input/install_response.xml -acceptLicense
On a Windows client system:
install.bat -s -input response_file -acceptLicense
For example:
install.bat -s -input c:\cms_install\input\install_response.xml -acceptLicense

What to do next

Follow the instructions in “Verifying that the client management service is installed
correctly.”

Verifying that the client management service is installed

correctly
Before you use the client management service to collect diagnostic information
about a backup-archive client, you can verify that the client management service is
correctly installed and configured.

Procedure

On the client system, at the command line, run the following commands to view
the configuration of the client management service:
v On Linux client systems, issue the following command:
client_install_dir/cms/bin/CmsConfig.sh list

where client_install_dir is the directory where the backup-archive client is

installed. For example, with the default client installation, issue the following
command:
/opt/tivoli/tsm/cms/bin/CmsConfig.sh list

The output is similar to the following text:

Listing CMS configuration

server1.example.com:1500 NO_SSL HOSTNAME

Capabilities: [LOG_QUERY]

Chapter 12. Getting started with the Operations Center 141

Getting started with the Operations Center

Opt Path: /opt/tivoli/tsm/client/ba/bin/dsm.sys

Log File: /opt/tivoli/tsm/client/ba/bin/dsmerror.log

en_US MM/dd/yyyy HH:mm:ss Windows-1252

Log File: /opt/tivoli/tsm/client/ba/bin/dsmsched.log

en_US MM/dd/yyyy HH:mm:ss Windows-1252
v On Windows client systems, issue the following command:
client_install_dir\cms\bin\CmsConfig.bat list

where client_install_dir is the directory where the backup-archive client is

installed. For example, with the default client installation, issue the following
command:
C:\"Program Files"\Tivoli\TSM\cms\bin\CmsConfig.bat list

The output is similar to the following text:

Listing CMS configuration

server1.example.com:1500 NO_SSL HOSTNAME

Capabilities: [LOG_QUERY]
Opt Path: C:\Program Files\Tivoli\TSM\baclient\dsm.opt

Log File: C:\Program Files\Tivoli\TSM\baclient\dsmerror.log

en_US MM/dd/yyyy HH:mm:ss Windows-1252

Log File: C:\Program Files\Tivoli\TSM\baclient\dsmsched.log

en_US MM/dd/yyyy HH:mm:ss Windows-1252
If the client management service is correctly installed and configured, the output
displays the location of the error log file.
The output text is extracted from the following configuration file:
v On Linux client systems:
client_install_dir/cms/Liberty/usr/servers/cmsServer/client-configuration.xml
v On Windows client systems:
client_install_dir\cms\Liberty\usr\servers\cmsServer\client-configuration.xml
If the output does not contain any entries, you must configure the
client-configuration.xml file. For instructions about how to configure this file,
see “Configuring the client management service for custom client installations” on
page 144. You can use the CmsConfig verify command to verify that a node
definition is correctly created in the client-configuration.xml file.

Configuring the Operations Center to use the client

management service
If you did not use the default configuration for the client management service, you
must configure the Operations Center to access the client management service.

Before you begin

Ensure that the client management service is installed and started on the client
system.

Verify whether the default configuration is used. The default configuration is not
used if either of the following conditions is met:
v The client management service does not use the default port number, 9028.

142 IBM Spectrum Protect for Windows: Installation Guide

 Getting started with the Operations Center

v The backup-archive client is not accessed by the same IP address as the client
system where the backup-archive client is installed. For example, a different IP
address might be used in the following situations:
– The computer system has two network cards. The backup-archive client is
configured to communicate on one network, while the client management
service communicates on the other network.
– The client system is configured with the Dynamic Host Configuration
Protocol (DHCP). As a result, the client system is dynamically assigned an IP
address, which is saved on the IBM Spectrum Protect server during the
previous backup-archive client operation. When the client system is restarted,
the client system might be assigned a different IP address. To ensure that the
Operations Center can always find the client system, you specify a fully
qualified domain name.

Procedure

To configure the Operations Center to use the client management service, complete
the following steps:
1. On the Clients page of the Operations Center, select the client.
2. Click Details.
3. Click the Properties tab.
4. In the Remote diagnostics URL field in the General section, specify the URL
for the client management service on the client system.
The address must start with https. The following table shows examples of the
remote diagnostics URL.

Type of URL Example

With DNS host name and default port, 9028 https://server.example.com
With DNS host name and non-default port https://server.example.com:1599
With IP address and non-default port https://192.0.2.0:1599

5. Click Save.

What to do next

You can access client diagnostic information such as client log files from the
Diagnosis tab in the Operations Center.

Starting and stopping the client management service

The client management service is automatically started after it is installed on the
client system. You might need to stop and start the service in certain situations.

Procedure
v To stop, start, or restart the client management service on Linux client systems,
issue the following commands:
– To stop the service:
service cms.rc stop
– To start the service:
service cms.rc start
– To restart the service:
service cms.rc restart

Chapter 12. Getting started with the Operations Center 143

Getting started with the Operations Center

v On Windows client systems, open the Services window, and stop, start, or restart
the IBM Spectrum Protect Client Management Services service.

Uninstalling the client management service

If you no longer have to collect client diagnostic information, you can uninstall the
client management service from the client system.

About this task

You must use IBM Installation Manager to uninstall the client management service.
If you no longer plan to use IBM Installation Manager, you can also uninstall it.

Procedure
1. Uninstall the client management service from the client system:
a. Open IBM Installation Manager:
v On the Linux client system, in the directory where IBM Installation
Manager is installed, go to the eclipse subdirectory (for example,
/opt/IBM/InstallationManager/eclipse), and issue the following
command:
./IBMIM
v On the Windows client system, open IBM Installation Manager from the
Start menu.
b. Click Uninstall.
c. Select IBM Spectrum Protect Client Management Services, and click Next.
d. Click Uninstall, and then click Finish.
e. Close the IBM Installation Manager window.
2. If you no longer require IBM Installation Manager, uninstall it from the client
system:
a. Open the IBM Installation Manager uninstall wizard:
v On the Linux client system, change to the IBM Installation Manager
uninstallation directory (for example, /var/ibm/InstallationManager/
uninstall), and issue the following command:
./uninstall
v On the Windows client system, click Start > Control Panel. Then, click
Uninstall a program > IBM Installation Manager > Uninstall.
b. In the IBM Installation Manager window, select IBM Installation Manager
if it is not already selected, and click Next.
c. Click Uninstall, and click Finish.

Configuring the client management service for custom client

installations
The client management service uses information in the client configuration file
(client-configuration.xml) to discover diagnostic information. If the client
management service is unable to discover the location of log files, you must run
the CmsConfig utility to add the location of the log files to the client-
configuration.xml file.

144 IBM Spectrum Protect for Windows: Installation Guide

 Getting started with the Operations Center

CmsConfig utility
If you are not using the default client configuration, you can run the CmsConfig
utility on the client system to discover and add the location of the client log files to
the client-configuration.xml file. After you complete the configuration, the client
management service can access the client log files and make them available for
basic diagnostic functions in the Operations Center.

You can also use the CmsConfig utility to show the configuration of the client
management service and to remove a node name from the client-
configuration.xml file.

The client-configuration.xml file is in the following directory:

v On Linux client systems:
client_install_dir/cms/Liberty/usr/servers/cmsServer
v On Windows client systems:
client_install_dir\cms\Liberty\usr\servers\cmsServer
where client_install_dir is the directory where the backup-archive client is installed.

The CmsConfig utility is available in the following locations.

Client operating system Utility location and name

Linux client_install_dir/cms/bin/CmsConfig.sh
Windows client_install_dir\cms\bin\CmsConfig.bat

To use the CmsConfig utility, issue any command that is included in the utility.
Ensure that you enter each command on a single line.

CmsConfig discover command:

You can use the CmsConfig discover command to automatically discover options
files and log files, and add them to the client configuration file,
client-configuration.xml. In this way, you can help to ensure that the client
management service can access the client log files and make them available for
diagnosis in the Operations Center.

Typically, the client management service installer runs the CmsConfig discover
command automatically. However, you must run this command manually if you
changed the backup-archive client, such as added a client, or changed the server
configuration or location of log files.

For the client management service to create a log definition in the

client-configuration.xml file, the IBM Spectrum Protect server address, server
port, and client node name must be obtained. If the node name is not defined in
the client options file (typically, dsm.sys on Linux client systems and dsm.opt on
Windows client systems), the host name of the client system is used.

To update the client configuration file, the client management service must access
one or more log files, such as dsmerror.log and dsmsched.log. For best results, run
the CmsConfig discover command in the same directory and by using the same
environment variables as you would for the backup-archive client command, dsmc.
In this way, you can improve the chances of finding the correct log files.

Chapter 12. Getting started with the Operations Center 145

Getting started with the Operations Center

If the client options file is in a custom location or it does not have a typical options
file name, you can also specify the path for the client options file to narrow the
scope of the discovery.

Syntax

►► CmsConfig discover ►◄
configPath

Parameters
configPath
The path of the client options file (typically dsm.opt). Specify the configuration
path when the client options file is not in a default location or it does not have
the default name. The client management service loads the client options file
and discovers the client nodes and logs from there. This parameter is optional.
On a Linux client system, the client management service always loads the
client user-options file (dsm.opt) first, and then looks for the client
system-options file (typically dsm.sys). The value of the configPath parameter,
however, is always the client user-options file.

Examples for a Linux client system

v Discover the client log files and automatically add the log definitions to the
client-configuration.xml file.
Issue the following command from the /opt/tivoli/tsm/cms/bin directory.
Command:
./CmsConfig.sh discover
Output:
Discovering client configuration and logs.

server.example.com:1500 SUSAN
/opt/tivoli/tsm/client/ba/bin/dsmerror.log

Finished discovering client configuration and logs.

v Discover the configuration files and log files that are specified in the
/opt/tivoli/tsm/client/ba/bin/daily.opt file and automatically add the log
definitions to the client-configuration.xml file.
Issue the following command from the /opt/tivoli/tsm/cms/bin directory.
Command:
./CmsConfig.sh discover /opt/tivoli/tsm/client/ba/bin/daily.opt
Output:
Discovering client configuration and logs

server.example.com:1500 NO_SSL SUSAN

Capabilities: [LOG_QUERY]
Opt Path: /opt/tivoli/tsm/client/ba/bin/dsm.sys

Log File: /opt/tivoli/tsm/client/ba/bin/dsmerror.log

en_US MM/dd/yyyy HH:mm:ss Windows-1252

Log File: /opt/tivoli/tsm/client/ba/bin/dsmsched.log

en_US MM/dd/yyyy HH:mm:ss Windows-1252

Finished discovering client configuration and logs.

146 IBM Spectrum Protect for Windows: Installation Guide

 Getting started with the Operations Center

Examples for a Windows client system

v Discover the client log files and automatically add the log definitions to the
client-configuration.xml file.
Issue the following command from the C:\Program Files\Tivoli\TSM\cms\bin
directory.
Command:
cmsconfig discover
Output:
Discovering client configuration and logs.

server.example.com:1500 SUSAN
C:\Program Files\Tivoli\TSM\baclient\dsmerror.log

Finished discovering client configuration and logs.

v Discover the configuration files and log files that are specified in the c:\program
files\tivoli\tsm\baclient\daily.opt file and automatically add the log
definitions to the client-configuration.xml file.
Issue the following command from the C:\Program Files\Tivoli\TSM\cms\bin
directory.
Command:
cmsconfig discover "c:\program files\tivoli\tsm\baclient\
daily.opt"
Output:
Discovering client configuration and logs

server.example.com:1500 NO_SSL SUSAN

Capabilities: [LOG_QUERY]
Opt Path: C:\Program Files\Tivoli\TSM\baclient\dsm.opt

Log File: C:\Program Files\Tivoli\TSM\baclient\dsmerror.log

en_US MM/dd/yyyy HH:mm:ss Windows-1252

Log File: C:\Program Files\Tivoli\TSM\baclient\dsmsched.log

en_US MM/dd/yyyy HH:mm:ss Windows-1252

Finished discovering client configuration and logs.

CmsConfig addnode command:

Use the CmsConfig addnode command to manually add a client node definition to
the client-configuration.xml configuration file. The node definition contains
information that is required by the client management service to communicate with
the IBM Spectrum Protect server.

Use this command only if the client options file or client log files are stored in a
non-default location on the client system.

Syntax

►► CmsConfig addnode nodeName serverIP serverPort serverProtocol optPath ►◄

Parameters
nodeName
The client node name that is associated with the log files. For most client

Chapter 12. Getting started with the Operations Center 147

Getting started with the Operations Center

systems, only one node name is registered to the IBM Spectrum Protect server.
However, on systems with multiple users, such as Linux client systems, there
can be more than one client node name. This parameter is required.
serverIP
The TCP/IP address of the IBM Spectrum Protect server that the client
management service authenticates to. This parameter is required.
You can specify a 1 - 64 character TCP/IP address for the server. The server
address can be a TCP/IP domain name or a numeric IP address. The numeric
IP address can be either a TCP/IP v4 or TCP/IP v6 address. You can use IPv6
addresses only if the commmethod V6Tcpip option is specified for the client
system.
Examples:
v server.example.com
v 192.0.2.0
v 2001:0DB8:0:0:0:0:0:0
serverPort
The TCP/IP port number that is used to communicate with the IBM Spectrum
Protect server. You can specify a value in the range 1 - 32767. This parameter is
required.
Example: 1500
serverProtocol
The protocol that is used for communication between the client management
service and the IBM Spectrum Protect server. This parameter is required.
You can specify one of the following values.

Value Meaning
NO_SSL The SSL security protocol is not used.
SSL The SSL security protocol is used.
FIPS The TLS 1.2 protocol is used in Federal
Information Processing Standard (FIPS)
mode.
Tip: Alternatively, you can enter TLS_1.2 to
specify that the TLS 1.2 protocol is used in
FIPS mode.

optPath
The fully qualified path of the client options file. This parameter is required.
Example (Linux client): /opt/backup_tools/tivoli/tsm/baclient/dsm.sys
Example (Windows client): C:\backup tools\Tivoli\TSM\baclient\dsm.opt

Example for a Linux client system

Add the node definition for client node SUSAN to the client-configuration.xml
file. The IBM Spectrum Protect server that the node communicates with is
server.example.com on server port 1500. The SSL security protocol is not used. The
path for the client system options file is /opt/tivoli/tsm/client/ba/bin/
custom_opt.sys.

Issue the following command from the /opt/tivoli/tsm/cms/bin directory.

148 IBM Spectrum Protect for Windows: Installation Guide

 Getting started with the Operations Center

Command:
./CmsConfig.sh addnode SUSAN server.example.com 1500 NO_SSL
/opt/tivoli/tsm/client/ba/bin/custom_opt.sys
Output:
Adding node.

Finished adding client configuration.

Example for a Windows client system

Add the node definition for client node SUSAN to the client-configuration.xml
file. The IBM Spectrum Protect server that the node communicates with is
server.example.com on server port 1500. The SSL security protocol is not used. The
path for the client options file is c:\program files\tivoli\tsm\baclient\
custom.opt.

Issue the following command. from the C:\Program Files\Tivoli\TSM\cms\bin

directory.
Command:
cmsconfig addnode SUSAN server.example.com 1500 NO_SSL "c:\program
files\tivoli\tsm\baclient\custom.opt"
Output:
Adding node.

Finished adding client configuration.

CmsConfig setopt command:

Use the CmsConfig setopt command to set the path of the client options file
(typically dsm.opt) to an existing node definition without first reading the contents
of the client options file.

This command can be helpful if the client options file does not have a typical
name or is in a non-default location.

Requirement: If the node definition does not exist, you must first issue the
CmsConfig addnode command to create the node definition.

Unlike the CmsConfig discover command, the CmsConfig setopt command does
not create associated log definitions in the client-configuration.xml file. You
must use the CmsComfog addlog command to create the log definitions.

Syntax

►► CmsConfig setopt nodeName optPath ►◄

Parameters
nodeName
The client node name that is associated with the log files. For most client
systems, only one node name is registered to the IBM Spectrum Protect server.
However, on systems with multiple users, such as Linux client systems, there
can be more than one client node name. This parameter is required.

Chapter 12. Getting started with the Operations Center 149

Getting started with the Operations Center

optPath
The fully qualified path of the client options file. This parameter is required.
Example (Linux client): /opt/backup_tools/tivoli/tsm/baclient/dsm.opt
Example (Windows client): C:\backup tools\Tivoli\TSM\baclient\dsm.opt

Example for a Linux client system

Set the client options file path for the node SUSAN. The path for the client options
file is /opt/tivoli/tsm/client/ba/bin/dsm.opt.

Issue the following command from the /opt/tivoli/tsm/cms/bin directory.

Command:
./CmsConfig.sh setopt SUSAN /opt/tivoli/tsm/client/ba/bin/dsm.opt
Output:
Adding node configuration file.

Finished adding client configuration file.

Example for a Windows client system

Set the client options file path for the node SUSAN. The path for the client options
file is c:\program files\tivoli\tsm\baclient\dsm.opt.

Issue the following command from the C:\Program Files\Tivoli\TSM\cms\bin

directory.
Command:
cmsconfig setopt SUSAN "c:\program files\tivoli\tsm\baclient\
dsm.opt"
Output:
Adding node configuration file.

Finished adding client configuration file.

CmsConfig setsys command:

On a Linux client system, use the CmsConfig setsys command to set the path of
the client system-options file (typically dsm.sys) to an existing node definition
without first reading the contents of the client system-options file.

This command can be helpful if the client system-options file does not have a
typical name or is in a non-default location.

Requirement: If the node definition does not exist, you must first issue the
CmsConfig addnode command to create the node definition.

Unlike the CmsConfig discover command, the CmsConfig setsys command does
not create associated log definitions in the client-configuration.xml file. You
must use the CmsComfog addlog command to create the log definitions.

Syntax

►► CmsConfig setsys nodeName sysPath ►◄

150 IBM Spectrum Protect for Windows: Installation Guide

 Getting started with the Operations Center

Parameters
nodeName
The client node name that is associated with the log files. For most client
systems, only one node name is registered to the IBM Spectrum Protect server.
However, on systems with multiple users, such as Linux client systems, there
can be more than one client node name. This parameter is required.
sysPath
The fully qualified path of the client system-options file. This parameter is
required.
Example: /opt/backup_tools/tivoli/tsm/baclient/dsm.sys

Example

Set the client system-options file path for the node SUSAN. The path for the client
system-options file is /opt/tivoli/tsm/client/ba/bin/dsm.sys.

Issue the following command, from the /opt/tivoli/tsm/cms/bin directory.

Command:
./CmsConfig.sh setopt SUSAN /opt/tivoli/tsm/client/ba/bin/dsm.sys
Output:
Adding node configuration file.

Finished adding client configuration file.

CmsConfig addlog command:

Use the CmsConfig addlog command to manually add the location of client log files
to an existing node definition in the client-configuration.xml configuration file.
Use this command only if the client log files are stored in a non-default location on
the client system.

Requirement: If the node definition does not exist, you must first issue the
CmsConfig addnode command to create the node definition.

Syntax

►► CmsConfig addlog nodeName logPath ►

► ►◄
language dateFormat timeFormat encoding

Parameters
nodeName
The client node name that is associated with the log files. For most client
systems, only one node name is registered to the IBM Spectrum Protect server.
However, on systems with multiple users, such as Linux client systems, there
can be more than one client node name. This parameter is required.
logPath
The fully qualified path of the log files. This parameter is required.
Example (Linux client): /opt/backup_tools/tivoli/tsm/baclient/dsmerror.log

Chapter 12. Getting started with the Operations Center 151

Getting started with the Operations Center

Example (Windows client): C:\backup tools\Tivoli\TSM\baclient\

dsmerror.log
language
The language locale of the log file. This parameter is optional. However, if you
specify this parameter, you must also specify the dateFormat, timeFormat, and
encoding parameters. You must specify the locale for the following languages.

Language Locale
Brazilian Portuguese pt_BR
Chinese, Simplified zh_CN
Chinese, Traditional zh_TW
Czech cs_CZ
English en_US
French fr_FR
German de_DE
Hungarian hu_HU
Italian it_IT
Japanese ja_JP
Korean ko_KR
Polish pl_PL
Russian ru_RU
Spanish es_ES

dateFormat
The date format of the time stamp entries in the client log file. This parameter
is optional. However, if you specify this parameter, you must also specify the
language, timeFormat, and encoding parameters.
The following table shows the date formats for the languages.

Tip: Instead of using one of the date formats that are listed in the table, you
can specify a date format by using the backup-archive client dateformat
option.

Language Date format

Chinese, Simplified yyyy-MM-dd
Chinese, Traditional yyyy/MM/dd
Czech dd.MM.yyyy
English MM/dd/yyyy
French dd/MM/yyyy
German dd.MM.yyyy
Hungarian yyyy.MM.dd
Italian dd/MM/yyyy
Japanese yyyy-MM-dd
Korean yyyy/MM/dd
Polish yyyy-MM-dd
Portuguese, Brazilian dd/MM/yyyy

152 IBM Spectrum Protect for Windows: Installation Guide

 Getting started with the Operations Center

Language Date format

Russian dd.MM.yyyy
Spanish dd.MM.yyyy

timeFormat
The time format of the time stamp entries in the client log file. This parameter
is optional. However, if you specify this parameter, you must also specify the
language, dateFormat, and encoding parameters.
The following table shows examples of default time formats that you can
specify and client operating systems.

Tip: Instead of using one of the time formats that are listed in the table, you
can specify a time format by using the backup-archive client timeformat
option.

Time format for Linux client Time format for Windows

Language systems client systems
Chinese, Simplified HH:mm:ss HH:mm:ss
Chinese, Traditional HH:mm:ss ahh:mm:ss
Czech HH:mm:ss HH:mm:ss
English HH:mm:ss HH:mm:ss
French HH:mm:ss HH:mm:ss
German HH:mm:ss HH:mm:ss
Hungarian HH.mm.ss HH:mm:ss
Italian HH:mm:ss HH:mm:ss
Japanese HH:mm:ss HH:mm:ss
Korean HH:mm:ss HH:mm:ss
Polish HH:mm:ss HH:mm:ss
Portuguese, Brazilian HH:mm:ss HH:mm:ss
Russian HH:mm:ss HH:mm:ss
Spanish HH:mm:ss HH:mm:ss

encoding
The character encoding of the entries in the client log files. This parameter is
optional. However, if you specify this parameter, you must also specify the
language, dateFormat, and timeFormat parameters.
For Linux client systems, the typical character encoding is UTF-8. For Windows
client systems, the default encoding values are shown in the following table. If
your client system is customized differently, use the encoding parameter to
specify a value other than the default.

Language Encoding
Chinese, Simplified CP936
Chinese, Traditional CP950
Czech Windows-1250
English Windows-1252
French Windows-1252

Chapter 12. Getting started with the Operations Center 153

Getting started with the Operations Center

Language Encoding
German Windows-1252
Hungarian Windows-1250
Italian Windows-1252
Japanese CP932
Korean CP949
Polish Windows-1250
Portuguese, Brazilian Windows-1252
Russian Windows-1251
Spanish Windows-1252

Example for a Linux client system

Add the client log file location to the existing definition for client node SUSAN in
the client-configuration.xml file. The path for the client log file is
/usr/work/logs/dsmerror.log. Add the language specification, time format, and
date format for the French locale.

Issue the following command from the /opt/tivoli/tsm/cms/bin directory.

Command:
./CmsConfig.sh addlog SUSAN /usr/work/logs/dsmerror.log fr_FR
yyyy/MM/dd HH:MM:ss UTF-8
Output:
Adding log.

Finished adding log.

Example for a Windows client system

Add the client log file location to the existing definition for client node SUSAN in
the client-configuration.xml. The path for the client log file is
c:\work\logs\dsmerror.log. Add the language specification, time format, and date
format for the French locale.

Issue the following command from the C:\Program Files\Tivoli\TSM\cms\bin

directory.
Command:
cmsconfig addlog SUSAN c:\work\logs\dsmerror.log fr_FR yyyy/MM/dd
HH:MM:ss UTF-8
Output:
Adding log.

Finished adding log.

154 IBM Spectrum Protect for Windows: Installation Guide

 Getting started with the Operations Center

CmsConfig remove command:

Use the CmsConfig remove command to remove a client node definition from the
client configuration file, client-configuration.xml. All log file entries that are
associated with the client node name are also removed.

Syntax

►► CmsConfig remove nodeName ►◄

Parameters
nodeName
The client node name that is associated with the log files. For most client
systems, only one node name is registered to the IBM Spectrum Protect server.
However, on systems with multiple users, such as Linux client systems, there
can be more than one client node name. This parameter is required.

Example for a Linux client system

Remove the node definition for SUSAN from the client-configuration.xml file.

Issue the following command from the /opt/tivoli/tsm/cms/bin directory.

Command:
./CmsConfig.sh remove SUSAN
Output:
Removing node.

Finished removing node.

Example for a Windows client system

Remove the node definition for SUSAN from the client-configuration.xml file.

Issue the following command from the C:\Program Files\Tivoli\TSM\cms\bin

directory.
Command:
cmsconfig remove SUSAN
Output:
Removing node.

Finished removing node.

CmsConfig verify command:

Use the CmsConfig verify command to verify that a node definition is correctly
created in the client-configuration.xml file. If there are errors with the node
definition or the node is not correctly defined, you must correct the node definition
by using the appropriate CmsConfig commands.

Chapter 12. Getting started with the Operations Center 155

Getting started with the Operations Center

Syntax

►► CmsConfig verify nodeName ►◄

cmsPort

Parameters
nodeName
The client node name that is associated with the log files. For most client
systems, only one node name is registered to the IBM Spectrum Protect server.
However, on systems with multiple users, such as Linux client systems, there
can be more than one client node name. This parameter is required.
cmsPort
The TCP/IP port number that is used to communicate with the client
management service. Specify the port number if you did not use the default
port number when you installed the client management service. The default
port number is 9028. This parameter is optional.

Example for a Linux client system

Verify that the node definition for the node SUSAN is created correctly in the
client-configuration.xml file.

Issue the following command from the /opt/tivoli/tsm/cms/bin directory.

Command:
./CmsConfig.sh verify SUSAN

During the verification process, you are prompted to enter the client node name or
administrative user ID and password.
Output:
Verifying node.

Verifying the CMS service configuration for node SUSAN.

The CMS configuration looks correct.

Verifying the CMS service works correctly on port 9028.

Enter your user id: admin

Enter your password:

Connecting to CMS service and verifying resources.

The CMS service is working correctly.
Finished verifying node.

Example for a Windows client system

Verify that the node definition for the node SUSAN is created correctly in the
client-configuration.xml file.

Issue the following command from the C:\Program Files\Tivoli\TSM\cms\bin

directory.
Commands:
cmsconfig verify SUSAN

156 IBM Spectrum Protect for Windows: Installation Guide

 Getting started with the Operations Center

During the verification process, you are prompted to enter the client node name or
administrative user ID and password.
Output:
Verifying node.

Verifying the CMS service configuration for node SUSAN.

The CMS configuration looks correct.

Verifying the CMS service works correctly on port 9028.

Enter your user id: admin

Enter your password:

Connecting to CMS service and verifying resources.

The CMS service is working correctly.
Finished verifying node.

CmsConfig list command:

Use the CmsConfig list command to show the client management service
configuration.

Syntax

►► CmsConfig list ►◄

Example for a Linux client system

Show the configuration of the client management service. Then, view the output to
ensure that you entered the command correctly.

Issue the following command from the /opt/tivoli/tsm/cms/bin directory.

Command:
./CmsConfig.sh list
Output:
Listing CMS configuration

server.example.com:1500 NO_SSL SUSAN

Capabilities: [LOG_QUERY]
Opt Path: /opt/tivoli/tsm/client/ba/bin/dsm.sys

Log File: /opt/tivoli/tsm/client/ba/bin/dsmerror.log

en_US MM/dd/yyyy HH:mm:ss Windows-1252

Log File: /opt/tivoli/tsm/client/ba/bin/dsmsched.log

en_US MM/dd/yyyy HH:mm:ss Windows-1252

Example for a Windows client system

Show the configuration of the client management service. Then, view the output to
ensure that you entered the command correctly.

Issue the following command from the C:\Program Files\Tivoli\TSM\cms\bin

directory.
Command:
cmsconfig list

Chapter 12. Getting started with the Operations Center 157

Getting started with the Operations Center

Output:
Listing CMS configuration

server.example.com:1500 NO_SSL SUSAN

Capabilities: [LOG_QUERY]
Opt Path: C:\Program Files\Tivoli\TSM\baclient\dsm.opt

Log File: C:\Program Files\Tivoli\TSM\baclient\dsmerror.log

en_US MM/dd/yyyy HH:mm:ss Windows-1252

Log File: C:\Program Files\Tivoli\TSM\baclient\dsmsched.log

en_US MM/dd/yyyy HH:mm:ss Windows-1252

CmsConfig help command:

Use the CmsConfig help command to show the syntax of CmsConfig utility
commands.

Syntax

►► CmsConfig help ►◄

Example for a Linux client system

Issue the following command from the /opt/tivoli/tsm/cms/bin directory:

./CmsConfig help

Example for a Windows client system

Issue the following command from the C:\Program Files\Tivoli\TSM\cms\bin

directory:
CmsConfig help

Advanced client management service capabilities:

By default, the IBM Spectrum Protect client management service collects

information only from client log files. To initiate other client actions, you can access
the Representational State Transfer (REST) API that is included with the client
management service.

API developers can create REST applications to initiate the following client actions:
v Query and update client options files (for example, the dsm.sys file on Linux
clients and the dsm.opt file on Linux and Windows clients).
v Query the status of the IBM Spectrum Protect client acceptor and the scheduler.
v Back up and restore files for a client node.
v Extend the capabilities of the client management service with scripts.

For detailed information about the client management service REST API, see the
Client Management Services REST API Guide.

158 IBM Spectrum Protect for Windows: Installation Guide

Chapter 13. Uninstalling the Operations Center
You can uninstall the Operations Center by using any of the following methods: a
graphical wizard, the command line in console mode, or silent mode.

Uninstalling the Operations Center by using a graphical wizard

You can uninstall the Operations Center by using the graphical wizard of IBM
Installation Manager.

Procedure
1. Open IBM Installation Manager.
You can open IBM Installation Manager from the Start menu.
2. Click Uninstall.
3. Select the option for the Operations Center, and click Next.
4. Click Uninstall.
5. Click Finish.

Uninstalling the Operations Center in console mode

To uninstall the Operations Center by using the command line, you must run the
uninstallation program of IBM Installation Manager from the command line with
the parameter for console mode.

Procedure
1. In the directory where IBM Installation Manager is installed, go to the
following subdirectory:
eclipse\tools
For example:
C:\Program Files\IBM\Installation Manager\eclipse\tools
2. From the tools directory, issue the following command:
imcl.exe -c
3. To uninstall, enter 5.
4. Choose to uninstall from the IBM Spectrum Protect package group.
5. Enter N for Next.
6. Choose to uninstall the Operations Center package.
7. Enter N for Next.
8. Enter U for Uninstall.
9. Enter F for Finish.

© Copyright IBM Corp. 1993, 2017 159

Uninstalling the Operations Center

Uninstalling the Operations Center in silent mode

To uninstall the Operations Center in silent mode, you must run the uninstallation
program of IBM Installation Manager from the command line with the parameters
for silent mode.

Before you begin

You can use a response file to provide data input to silently uninstall the
Operations Center server. IBM Spectrum Protect includes a sample response file,
uninstall_response_sample.xml, in the input directory where the installation
package is extracted. This file contains default values to help you avoid any
unnecessary warnings.

To uninstall the Operations Center, leave modify="false" set for the Operations
Center entry in the response file.

If you want to customize the response file, you can modify the options that are in
the file. For information about response files, see Response files.

Procedure
1. In the directory where IBM Installation Manager is installed, go to the
following subdirectory:
eclipse\tools
For example:
C:\Program Files\IBM\Installation Manager\eclipse\tools
2. From the tools directory, issue the following command, where response_file
represents the response file path, including the file name:
imcl.exe -input response_file -silent
The following command is an example:
imcl.exe -input C:\tmp\input\uninstall_response.xml -silent

160 IBM Spectrum Protect for Windows: Installation Guide

Chapter 14. Rolling back to a previous version of the
Operations Center
By default, IBM Installation Manager saves earlier versions of a package to roll
back to if you experience a problem with later versions of updates, fixes, or
packages.

Before you begin

The rollback function is available only after the Operations Center is updated.

About this task

When IBM Installation Manager rolls back a package to a previous version, the
current version of the package files is uninstalled, and an earlier version is
reinstalled.

To roll back to a previous version, IBM Installation Manager must access files for
that version. By default, these files are saved during each successive installation.
Because the number of saved files increases with each installed version, you might
want to delete these files from your system on a regular schedule. However, if you
delete the files, you cannot roll back to a previous version.

To delete saved files or to update your preference for saving these files in future
installations, complete the following steps:
1. In IBM Installation Manager, click File > Preferences.
2. On the Preferences page, click Files for Rollback, and specify your preference.

Procedure
To roll back to a previous version of the Operations Center, use the Roll Back
function of IBM Installation Manager.

© Copyright IBM Corp. 1993, 2017 161

162 IBM Spectrum Protect for Windows: Installation Guide
Part 3. Appendixes

© Copyright IBM Corp. 1993, 2017 163

164 IBM Spectrum Protect for Windows: Installation Guide
Appendix A. Installation log files
If you experience errors during installation, these errors are recorded in log files
that are stored in the IBM Installation Manager logs directory.

You can view installation log files by clicking File > View Log from the Installation
Manager tool. To collect these log files, click Help > Export Data for Problem
Analysis from the Installation Manager tool.

© Copyright IBM Corp. 1993, 2017 165

166 IBM Spectrum Protect for Windows: Installation Guide
Appendix B. Services associated with the server
When you start the IBM Spectrum Protect server as a service, other services start
automatically. These services are associated with the database manager, DB2.

The following services are associated with the server.

Service name Purpose Comments

TSM Server_instance The service for the server instance Set the start and stop options for this
that is named Server_instance. service to start and stop the server
instance automatically.
For example: TSM Server1
Each server instance runs as a
separate service.
DB2 - DB2TSM1 - SERVER_INSTANCE The DB2 service for the server This service is automatically started
instance that is named when the service for the server
Server_instance. instance is started. The DB2 service is
not stopped automatically when you
For example: DB2 - DB2TSM1 - stop the service for the server.
SERVER1
The system has one of these services
for each server-instance service that is
started on the system.
DB2 Governor (DB2TSM1) A DB2 service that is created at Do not change the options for this
installation time, and is required for service.
all server instances.
DB2 License Server (DB2TSM1) A DB2 service that is created at Do not change the options for this
installation time, and is required for service.
all server instances.
DB2 Management Server (DB2TSM1) A DB2 service that is created at Do not change the options for this
installation time, and is required for service.
all server instances.
DB2 Remote Command Server A DB2 service that is created at Do not change the options for this
(DB2TSM1) installation time, and is required for service.
all server instances.

© Copyright IBM Corp. 1993, 2017 167

168 IBM Spectrum Protect for Windows: Installation Guide
Appendix C. Accessibility features for the IBM Spectrum
Protect product family
Accessibility features assist users who have a disability, such as restricted mobility
or limited vision, to use information technology content successfully.

Overview

The IBM Spectrum Protect family of products includes the following major
accessibility features:
v Keyboard-only operation
v Operations that use a screen reader

The IBM Spectrum Protect family of products uses the latest W3C Standard,
WAI-ARIA 1.0 (www.w3.org/TR/wai-aria/), to ensure compliance with US Section
508 (www.access-board.gov/guidelines-and-standards/communications-and-it/
about-the-section-508-standards/section-508-standards) and Web Content
Accessibility Guidelines (WCAG) 2.0 (www.w3.org/TR/WCAG20/). To take
advantage of accessibility features, use the latest release of your screen reader and
the latest web browser that is supported by the product.

The product documentation in IBM Knowledge Center is enabled for accessibility.

The accessibility features of IBM Knowledge Center are described in the
Accessibility section of the IBM Knowledge Center help (www.ibm.com/support/
knowledgecenter/about/releasenotes.html?view=kc#accessibility).

Keyboard navigation

This product uses standard navigation keys.

Interface information

User interfaces do not have content that flashes 2 - 55 times per second.

Web user interfaces rely on cascading style sheets to render content properly and
to provide a usable experience. The application provides an equivalent way for
low-vision users to use system display settings, including high-contrast mode. You
can control font size by using the device or web browser settings.

Web user interfaces include WAI-ARIA navigational landmarks that you can use to
quickly navigate to functional areas in the application.

Vendor software

The IBM Spectrum Protect product family includes certain vendor software that is
not covered under the IBM license agreement. IBM makes no representation about
the accessibility features of these products. Contact the vendor for accessibility
information about its products.

© Copyright IBM Corp. 1993, 2017 169

 Related accessibility information

In addition to standard IBM help desk and support websites, IBM has a TTY
telephone service for use by deaf or hard of hearing customers to access sales and
support services:

TTY service
800-IBM-3383 (800-426-3383)
(within North America)

For more information about the commitment that IBM has to accessibility, see IBM
Accessibility (www.ibm.com/able).

170 IBM Spectrum Protect for Windows: Installation Guide

Notices
This information was developed for products and services offered in the US. This
material might be available from IBM in other languages. However, you may be
required to own a copy of the product or product version in that language in order
to access it.

IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing

IBM Corporation
North Castle Drive, MD-NC119
Armonk, NY 10504-1785
US

For license inquiries regarding double-byte character set (DBCS) information,

contact the IBM Intellectual Property Department in your country or send
inquiries, in writing, to:

Intellectual Property Licensing

Legal and Intellectual Property Law
IBM Japan Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS

PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. Some jurisdictions do not allow disclaimer of
express or implied warranties in certain transactions, therefore, this statement may
not apply to you.

This information could include technical inaccuracies or typographical errors.

Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.

Any references in this information to non-IBM websites are provided for

convenience only and do not in any manner serve as an endorsement of those

© Copyright IBM Corp. 1993, 2017 171

 websites. The materials at those websites are not part of the materials for this IBM
product and use of those websites is at your own risk.

IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:

IBM Director of Licensing

IBM Corporation
North Castle Drive, MD-NC119
Armonk, NY 10504-1785
US

Such information may be available, subject to appropriate terms and conditions,

including in some cases, payment of a fee.

The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.

The performance data discussed herein is presented as derived under specific

operating conditions. Actual results may vary.

Information concerning non-IBM products was obtained from the suppliers of

those products, their published announcements or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.

This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which

illustrate programming techniques on various operating platforms. You may copy,
modify, and distribute these sample programs in any form without payment to
IBM, for the purposes of developing, using, marketing or distributing application
programs conforming to the application programming interface for the operating
platform for which the sample programs are written. These examples have not
been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or
imply reliability, serviceability, or function of these programs. The sample
programs are provided "AS IS", without warranty of any kind. IBM shall not be
liable for any damages arising out of your use of the sample programs.

172 IBM Spectrum Protect for Windows: Installation Guide

Each copy or any portion of these sample programs or any derivative work must
include a copyright notice as follows: © (your company name) (year). Portions of
this code are derived from IBM Corp. Sample Programs. © Copyright IBM Corp.
_enter the year or years_.

Trademarks

IBM, the IBM logo, and ibm.com® are trademarks or registered trademarks of
International Business Machines Corp., registered in many jurisdictions worldwide.
Other product and service names might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the Web at "Copyright and
trademark information" at www.ibm.com/legal/copytrade.shtml.

Adobe is a registered trademark of Adobe Systems Incorporated in the United

States, and/or other countries.

Linear Tape-Open, LTO, and Ultrium are trademarks of HP, IBM Corp. and
Quantum in the U.S. and other countries.

Intel and Itanium are trademarks or registered trademarks of Intel Corporation or

its subsidiaries in the United States and other countries.

Linux is a registered trademark of Linus Torvalds in the United States, other

countries, or both.

Microsoft, Windows, and Windows NT are trademarks of Microsoft Corporation in

the United States, other countries, or both.

Java and all Java-based trademarks and logos are trademarks or registered
trademarks of Oracle and/or its affiliates.

SoftLayer® is a registered trademark of SoftLayer, Inc., an IBM Company.

UNIX is a registered trademark of The Open Group in the United States and other
countries.

Terms and conditions for product documentation

Permissions for the use of these publications are granted subject to the following
terms and conditions.
Applicability
These terms and conditions are in addition to any terms of use for the IBM
website.
Personal use
You may reproduce these publications for your personal, noncommercial
use provided that all proprietary notices are preserved. You may not
distribute, display or make derivative work of these publications, or any
portion thereof, without the express consent of IBM.
Commercial use
You may reproduce, distribute and display these publications solely within
your enterprise provided that all proprietary notices are preserved. You
may not make derivative works of these publications, or reproduce,
distribute or display these publications or any portion thereof outside your
enterprise, without the express consent of IBM.

Notices 173
 Rights Except as expressly granted in this permission, no other permissions,
licenses or rights are granted, either express or implied, to the publications
or any information, data, software or other intellectual property contained
therein.
IBM reserves the right to withdraw the permissions granted herein
whenever, in its discretion, the use of the publications is detrimental to its
interest or, as determined by IBM, the above instructions are not being
properly followed.
You may not download, export or re-export this information except in full
compliance with all applicable laws and regulations, including all United
States export laws and regulations.
IBM MAKES NO GUARANTEE ABOUT THE CONTENT OF THESE
PUBLICATIONS. THE PUBLICATIONS ARE PROVIDED "AS-IS" AND
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
IMPLIED, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES
OF MERCHANTABILITY, NON-INFRINGEMENT, AND FITNESS FOR A
PARTICULAR PURPOSE.

Privacy policy considerations

IBM Software products, including software as a service solutions, (“Software
Offerings”) may use cookies or other technologies to collect product usage
information, to help improve the end user experience, to tailor interactions with
the end user, or for other purposes. In many cases no personally identifiable
information is collected by the Software Offerings. Some of our Software Offerings
can help enable you to collect personally identifiable information. If this Software
Offering uses cookies to collect personally identifiable information, specific
information about this offering’s use of cookies is set forth below.

This Software Offering does not use cookies or other technologies to collect
personally identifiable information.

If the configurations deployed for this Software Offering provide you as customer
the ability to collect personally identifiable information from end users via cookies
and other technologies, you should seek your own legal advice about any laws
applicable to such data collection, including any requirements for notice and
consent.

For more information about the use of various technologies, including cookies, for
these purposes, see IBM’s Privacy Policy at http://www.ibm.com/privacy and
IBM’s Online Privacy Statement at http://www.ibm.com/privacy/details in the
section entitled “Cookies, Web Beacons and Other Technologies,” and the “IBM
Software Products and Software-as-a-Service Privacy Statement” at
http://www.ibm.com/software/info/product-privacy.

174 IBM Spectrum Protect for Windows: Installation Guide

Glossary
A glossary is available with terms and definitions for the IBM Spectrum Protect family of products.

See the IBM Spectrum Protect glossary.

To view glossaries for other IBM products, see IBM Terminology.

© Copyright IBM Corp. 1993, 2017 175

176 IBM Spectrum Protect for Windows: Installation Guide
Index
A client management service (continued)
Operations Center
accessibility features 169 view client log files 139
activating remove node name 155, 156
server requirements and limitations 115
Windows 63 REST API 158
activating server options 57 set client options file path 149
active log set client system-options file path 150
space requirements 28 show configuration 157
storage technology selection 18 starting and stopping 143
administrative commands uninstalling 144
HALT 68 verifying installation 141
REGISTER LICENSE 68 client nodes
administrator ID 116 reverting to previous server version
administrator password 116 data affected 95
alerts client-configuration.xml file 141, 144, 145
sending by email 129 cluster configuration 97
API 61 cluster environment
API configuration 61 DB2 97
archive failover log space clustered environment
description 40 applying a fix pack to a V8 server 75
archive log upgrading server on Windows
space requirements 28 V6.1 to V8.1.2 89
storage technology selection 18 V6.3 or V7.1 to V8.1.2 87
archive log directory 51 upgrading the server to V8.1.2 86
CmsConfig utility
addlog 151
B addnode 147
BACKUP DB command 61 client management service 145
backups discover 145
database 68 help 158
list 157
remove 155, 156
C setopt 149
setsys 150
capacity planning commands
database space requirements administrative, SET DBRECOVERY 68
estimates based on number of files 25 DSMSERV FORMAT 60
estimates based storage pool capacity 27 commands, administrative
starting size 24 HALT 68
recovery log space requirements REGISTER LICENSE 68
active and archive logs 28 communication methods
active log mirror 40 Named Pipes 58
client management service setting 57
add log file location 151 TCP/IP 57
add node definition 147 components
advanced capabilities 158 installable v
CmsConfig addlog 151 configuration
CmsConfig addnode 147 Operations Center 110
CmsConfig discover 145 configuring 51, 53, 55
CmsConfig help 158 communication protocols 57
CmsConfig list 157 hub server 128
CmsConfig remove 155, 156 Operations Center 127
CmsConfig setopt 149 spoke server 129
CmsConfig setsys 150 configuring the Operations Center
CmsConfig utility 145 for client management service 142
collecting diagnostic information 139 configuring, manually 53, 55
configuring for custom client installation 144 configuring, server instance 53
configuring the Operations Center 142 configuring, wizard 53, 54
installing 139 Console language support 49
in silent mode 140 console mode 47

© Copyright IBM Corp. 1993, 2017 177

create server instance 51, 53
custom configuration
G
client management service 144 group 51
GSKit
removing Version 7 92
Version 7 92
D Version 8 92
data deduplication
effects when reverting to previous server version 95
database
backups 68
H
installing 60 HALT command 68
name 42 halting the server 68
storage technology selection 18 hardware requirements
database directories 51 IBM Spectrum Protect 20
database manager 27, 61 home directory 56
database manager (DB2TSM1) 167 HTTPS 133, 135
DB2 commands 99 password for truststore file 118, 136
DB2 directories 44 hub server 110
db2icrt command 56 configuring 128
default installation directories 44
device driver, IBM Spectrum Protect v
directories I
DB2 44 IBM Installation Manager 23, 117, 118
default installation 44 uninstalling 106
devices 44 IBM Knowledge Center vi
languages 44 IBM Spectrum Protect
naming for server 42 installation 46, 47
directories, instance 51 installation packages 45
disability 169 server changes
DISK device class Version 8.1 vii
checklist for disk systems 16 uninstalling 103
storage technology selection 18 in silent mode 104
disk performance using a graphical installation wizard 103
checklist for active log 9 using command line in console mode 104
checklist for server database 7 upgrading
checklist for server recovery log 9 8.1 79
checklist for storage pools on disk 16 V7.1 to V8.1 80
disk space 20 IBM Spectrum Protect device driver, installable package v
disk systems IBM Spectrum Protect fix packs 73
checklist for active log 9 IBM Spectrum Protect on AIX
checklist for server database 7 upgrading
checklist for server recovery log 9 V8.1 80
classification 18 IBM Spectrum Protect support site 45
selecting 18 IBM Spectrum Protect, setting up 63
storage pools on disk 16 installable components v
DSMSERV FORMAT command 60 installation directories
dsmserv.v6lock 68 Operations Center
Installation Manager 118
installation log 46, 47
E Installation Manager 23, 117, 118
email alerts 129 logs directory 165
suspending temporarily 131 installation packages 45
enabling client/server communications 57 Operations Center 121
installation wizard 46
installing
client management service 139
F database 60
FILE device class device support 45
checklist for disk systems 16 fix packs 73
storage technology selection 18 graphical user interface
first steps 51 using 46
fix packs 73 minimum requirements for 20
fixes 45 Operations Center 121
recovery log 60
server 3, 45
using command line in console mode
using 47

178 IBM Spectrum Protect for Windows: Installation Guide

installing (continued)
what to know about security 3
O
what to know before 3 offering 23, 117
installing the IBM Spectrum Protect server 48 operating system requirements
installing the server Operations Center 113
silently 48 Operations Center v
installingOperations Center 107 administrator IDs 116
instance directories 51 Chrome 114
instance user ID 42 computer requirements 110
interim fix 73 configuring 127
iPad credentials for installing 118
monitoring the storage environment 138 Firefox 114
hub server 110
IE 114
installation directory 118
K installation packages 121
keyboard 169 installing 107, 121
KILL command 68 in silent mode 122
Knowledge Center vi using a graphical wizard 121
using command line in console mode 122
Internet Explorer 114
L language requirements 114
LANGUAGE option 49, 50 login screen text 132
language package 50 opening 128, 138
language packages 49 operating system requirements 113
language support 50 overview 109
languages password for secure communications 118, 136
set 50 port number 118, 138
license, IBM Spectrum Protect 68 prerequisite checks 109
licenses rolling back to a previous version 161
installable package v Safari 114
limitations spoke server 110, 129
client management service 115 SSL 133, 135
Local System account 64 system requirements 109
log files uninstalling 159
installation 165 in silent mode 160
login screen text using a graphical wizard 159
Operations Center 132 using command line in console mode 159
upgrading 107, 125
URL 138
web browser requirements 114
M web server 138
maintenance mode 67 options
maintenance updates 73 communications 57
memory requirements 20 starting the server 63
mobile device options, client
monitoring the storage environment 138 SSLTCPADMINPORT 58
monitoring SSLTCPPORT 58
logs 70 TCPADMINPORT 58
monitoring administrator 116 TCPPORT 58
multiple servers TCPWINDOWSIZE 58
upgrading overview
multiple servers 69 Operations Center 107, 109

N P
Named Pipes 58 package 23, 117
names, best practices package group 23, 117
database name 42 Passport Advantage 45
directories for server 42 password
instance user ID 42 Operations Center truststore file 118, 136
server instance 42 password for secure communications 118
server name 42 performance
new features vii configuration best practices 19
Operations Center 110

Index 179
planning, capacity server database
database space requirements checklist for disks 7
estimates based on number of files 25 directories 7
estimates based storage pool capacity 27 reorganization options 62
starting size 24 storage paths 7
recovery log space requirements server hardware
active log mirror 40 checklist for server system 4
recovery log space requirementsv 28 checklist for storage pools on disk 16
port number storage technology choices 18
Operations Center 118, 138 server instance 53, 56
prerequisite checks server instance, creating 56
Operations Center 109 server instances
publications vi naming 42
naming best practices 42
server license 68
R server recovery log
checklist for disks 9
recovery log
server,
archive failover log space 40
activating 63
installing 60
setting up 63
reference, DB2 commands 99
starting 63
REGISTER LICENSE command 68
server, IBM Spectrum Protect
Remote Execution Protocol 55
halting 68
repository 23, 117
options 57
requirements
services
client management service 115
starting the server as a Windows service
requirements for installation 20
configuration 64
resource requirements
procedure 65
Operations Center 110
services on Windows systems
reverting
database manager (DB2TSM1) 167
Windows cluster 97
DB2 167
reverting to previous server version 95
server 167
REXEC 55
SET DBRECOVERY 68
rollback 41, 42
shared resources directory 23, 117
Operations Center 161
silent installation
IBM Spectrum Protect 48
software requirements
S IBM Spectrum Protect 20
secure communications 133, 135 spoke server 110
Secure Sockets Layer 133, 135 adding 129
Secure Sockets Layer (SSL) SSL 133, 135
communication using 59 password for truststore file 118, 136
Transport Layer Security (TLS) 59 SSL (Secure Sockets Layer)
server communication using 59
after upgrade Transport Layer Security 59
reverting to previous server version 95 SSLTCPADMINPORT option 58
before upgrade SSLTCPPORT option 58
importance of preparation steps 95 stand-alone mode 67
naming best practices 42 starting
performance optimization 4 client management service 143
starting server 63
maintenance mode 67 startup
stand-alone mode 67 server
starting as a service maintenance mode 67
configuration 64 stand-alone mode 67
procedure 65 status monitoring 110
stopping 68 stopping
upgrading client management service 143
to 8.1 79 server 68
V7.1 to V8.1 80 storage pools 16
server active log reverting to previous server version 95
checklist for disks 9 storage technology selection 18
server AIX storage technology selection 18
upgrading summary of amendments
V8.1 80 Version 8.1 vii
server archive log system requirements
checklist for disks 9 Operations Center 109, 110, 113, 114

180 IBM Spectrum Protect for Windows: Installation Guide

T Windows services
creating
TCP/IP manually 66
setting options 57 IBM Spectrum Protect server 167
Version 4 57 starting the server
Version 6 57 configuration 64
TCPNODELAY option 58 procedure 65
TCPPORT option 58 wizard 51
TCPWINDOWSIZE option 58 worksheet
technical changes vii server space planning 23
temporary disk space 27
temporary space 27
time
server upgrade 80
TLS 133, 135
translation features 49
translations 49
Transport Layer Security (TLS) 59
Transport Layer Security protocol 133, 135
truststore file 133, 135
Operations Center 118
resetting password 136
tuning
Operations Center 110

U
Uninstall
IBM Installation Manager 106
uninstalling 105
client management service 144
uninstalling and reinstalling 105
updating 50, 125
upgrade
server
estimated time 80
to 8.1 79
V7.1 to V8.1 80
upgrade AIX
server
V8.1 80
upgrading Operations Center 107
URL
Operations Center 138
US English 50
User Account Control 55
user ID 51

V
verifying installation
client management service 141

W
web server
starting 138
stopping 138
Windows
cluster reverting 97
system requirements 20
Windows clustered environment
applying a fix pack to a V8 server 75
Windows Server 55

Index 181
182 IBM Spectrum Protect for Windows: Installation Guide
IBM®

Product Number: 5725-W99

5725-W98
5725-X15

Printed in USA