Vendor and configuration parameters (IBM Tivoli Storage Manager)

The IBM® Tivoli® Storage Manager (TSM) software controls a fixed content device. Use the configuration parameters to assign the attribute values for your fixed content device.

For full information on these parameters, see the following documents:

Type
The list displays those fixed content device providers certified for the present release.
Vendor
This read-only field displays the fixed content device provider vendor's name.
Test Connection
When you click the Test Connection button, Enterprise Manager tries to log onto the fixed content product using the parameters entered on this page (described in the following table). It then displays a success or failure message.
Configuration Parameters (IBM Tivoli Storage Manager)
Attribute Name Attribute Value
FCP Pool Idle Timeout Seconds Integer
Default=300
The number of seconds that an idle connection can remain in the fixed content provider (FCP) pool before the connection is eligible to be closed and removed from the pool. An idle connection will be closed when the next operation to the same fixed content device is performed after this idle period. The value must be greater than or equal to zero. Values less than zero are treated as zero.
FCP Pool Preferred Size Integer
Default=5
The preferred size (number of instances) of the fixed content provider pool. This is minimum size to which the fixed content device provider pool will be allowed to shrink after the idle timeout has expired. Values less than zero are treated as zero.
FCP Pool Max Wait Seconds Integer
Default=5
The maximum number of seconds to wait for a connection after the FCP Pool Max In Use limit has been reached. If a connection from the FCP pool does become available before this wait time expires, the request is allowed to proceed.
FCP Pool Max In Use Integer
Default=30
The maximum number of concurrent connections to the TSM server.

This value combined across all fixed content devices for all Content Engine instances should not exceed the maximum number of connections allowed by the Tivoli Storage Manager server as specified by the MAXSESSIONS option on the Tivoli Storage Manager Server.

NOTE  The IBM DR550 has a default MAXSESSIONS limit of 100, but other Tivoli Storage Manager servers generally have a default MAXSESSIONS limit of 25. You should increase the MAXSESSIONS limit to a much higher value, such as 500, for example. The maximum value is limited only by available virtual memory size or communication resources.

Configuration Files Share String
The full path of the root directory that contains the configuration options files for the Tivoli Storage Manager server fixed content device. This should be a networked directory that should be shared with read/write privileges so that all Content Engine server instances in a Content Engine server farm can access it using this exact path. The configuration option files in this directory are written to by the Content Engine server whenever various TivoliFixedContentDevice object properties are changed. This directory should be included in any backup procedures for disaster recovery purposes.

In a Content Engine server farm, this directory must be accessible by all Content Engine servers in the farm using this exact path.
IP Address String
The IP address or computer name of the Tivoli Storage Manager server. This property corresponds to the TCPSERVERADDRESS option in a Tivoli Storage Manager options file.
Port Integer
Default=1500
The port number of the Tivoli Storage Manager server. This property corresponds to the tcpport option in a Tivoli Storage Manager options file.
Archive Protection Flag Boolean
Default=TRUE
Specifies whether data retention protection is enabled on the Tivoli Storage Manager server (true) or not (false). This property corresponds to the value of the ENABLEARCHIVERETENTIONPROTECTION option in a Tivoli Storage Manager options file, and must match the Archive Retention Protection setting on the Tivoli Storage Manager server. If data retention protection is enabled, an archived object cannot be deleted from the server until policy-based retention requirements for that object have been satisfied.
Compression Flag Boolean
Default=TRUE
Specifies whether files will be compressed before they are sent to the Tivoli Storage Manager server (true) or not (false). This property corresponds to the value of the COMPression option in a Tivoli Storage Manager options file.

Compressing the data on the Content Engine server reduces demand on the network and on the Tivoli Storage Manager server. The reduced amount of data on the Tivoli Storage Manager server continues to provide performance benefits whenever this data is moved, such as for storage pool migration and storage pool backup. However, compression can significantly reduce the performance of the Content Engine server with an additional CPU load of 20-30%. For maximum performance with small data, a fast network and fast server, turn compression off.

Node Name String

The name of the Tivoli Storage Manager client node to use for connecting to the Tivoli Storage Manager server.

All Content Engine objects that are archived to the Tivoli Storage Manager server will be written and retrieved under this node name. The client node must be configured to have proper read and write access to the Tivoli Storage Manager system, and must be allowed to make multiple connections to the Tivoli Storage Manager server.

Password String (encrypted)
The password of the client node name to use for connecting to the Tivoli Storage Manager server.
Confirm Password String (encrypted)
Confirm the password. This value is not passed to the Tivoli Storage Manager server. Enterprise Manager uses this field to validate the password.
Owner Name String (optional)
The owner name to use for connecting to the Tivoli Storage Manager server and for archiving and retrieving Content Engine objects. This property is included for legacy reasons and is normally left blank.
Filespace Name String
The file space name to use for archiving Content Engine objects in Tivoli Storage Manager. The Create a Fixed Content Device wizard creates the file space for you. The file space name must begin with a forward slash (/).
Application Type String
Default="FileNetP8"
A string that identifies the Content Engine application to the Tivoli Storage Manager server. It does not need to be unique.
Options String (optional)
A string that contains configuration options to be passed to the Tivoli Storage Manager server when connecting to it. These configuration options override the settings specified in the Tivoli Storage Manager options files. This string is not normally used and might contain P8-specific data that is not passed to the Tivoli Storage Manager server.
DSMI Directory String (optional)
If this property is set, it indicates that a Content Engine UNIX server (the Tivoli Storage Manager client) is connected to the Tivoli Storage Manager server and specifies the full path of the Tivoli Storage Manager client directory that contains the dsm.sys file. For example, on AIX servers, this location is typically /usr/tivoli/tsm/client/ba/bin.

If this property is not set, it indicates that the Content Engine server (the Tivoli Storage Manager client) is on a Microsoft® Windows® system.

Important:  Include this directory in any backup procedures for disaster recovery purposes.

Write Buffer Size Integer (optional)
Default=65536 (64 KB)
The buffer size, in bytes, to use when transferring content from the Content Engine server to the Tivoli Storage Manager server. A large buffer can improve communication performance but requires more memory. If most of the content being stored on the Tivoli Storage Manager server is fairly small, then 24 KB is a good value to use for this property. If most of the content is large, then 256 KB is a good value. Do not exceed 1 MB when setting this value.
Concurrent Tape Readers Integer (optional)
Default=1
The maximum number of concurrent users that are allowed to wait for a tape to be mounted for each Content Engine instance, for each Tivoli Storage Manager Fixed Content Device. That is, each instance of Content Engine can have up to this number of users waiting for a tape to be mounted for each Tivoli Storage Manager fixed content device. The default value of one limits each Content Engine instance to one user waiting for a tape to be mounted for each Tivoli Storage Manager Fixed Content Device.

If your tape library contains multiple tape drives, the minimum value for this parameter should be equal to the number of drives in the library. You can also increase the value of this parameter if the tape is either normally already mounted (you have a small number of tapes) or if the tape can be mounted quickly. Depending on how your data is collocated on tapes and the performance of your tape library, you can increase the value of this parameter, especially if you get a high number of retrieval failures for documents on tape, and you believe that your tape library should be able to handle more of these requests.

Each waiting user takes up one Tivoli Storage Manager session and one item in the Fixed Content Provider Pool. The Tivoli Storage Manager MAXSESSIONS and Content Engine FCP Pool Max In Use parameters might need to be adjusted to account for users who are waiting for a tape to be mounted.

When you set the Concurrent Tape Readers parameter, follow these guidelines:

  • This parameter must be lower than the Tivoli Storage Manager MAXSESSIONS parameter to allow other users to access the Tivoli Storage Manager device.
  • If this parameter is set too low, many users might receive unnecessary failure messages when attempting to read from tape.
  • If this parameter is set too high, a large number of users might be queued up waiting for tape, consuming all Tivoli Storage Manager sessions, not allowing other users to read from TSM, and preventing migration of new content to TSM.
Mount Wait Duration This property is not supported.