Version 5.5 IBM Tivoli Storage Manager Using the Application Program Interface Updates

Tivoli Storage Manager API Documentation Updates

Post-version 5.5.2 documentation updates

Per APAR IC63239:
Chapter 3. Design recommendations and considerations
In "Table 7. Design recommendations", replace first bullet with:

• Make the node name unique for each Tivoli Storage Manager backup-archive client and Tivoli Storage Manager API client product that you use. Examples of these clients are Tivoli Storage Manager for Mail or Tivoli Storage Manager HSM for Windows.

Version 5.5.2 documentation updates
There are no document updates at this time.

Version 5.5.1 documentation updates
Mac support is added to the API.
This produces a global change:

• from "UNIX, Linux, and OS/400" to "UNIX, Linux, OS/400, and Mac OS X"

Do a global replacement of the word "Intel" by "Windows".

Chapter 2. UNIX or Linux sample application source files
In Table 4, after "callmt2.c", add:
callmtu1.c Multithreaded Unicode sample files
callmtu2.c

Chapter 3. Sending data to a server
LAN-free is not supported on Mac.

Appendix E. The X/Open Backup Services API
The X/Open API for Tivoli Storage Manager is also available on the Mac platform.



Version 5.5.0 documentation updates


Chapter 3. API design recommendations and considerations
Topic: "The enablearchiveretentionprotection option"
The backup-archive client does support data retention protection. The following note is erroneous:

Note: This option is valid for API applications only. The backup-archive client does not support data retention protection for archive objects to a Tivoli Storage Manager retention protection server.

Chapter 3. API design recommendations and considerations

The following section was added between "Using passwordaccess generate without TCA" and "Creating an administrative user with client owner authority".

Authentication in a clustered environment

The enhanced nodename feature allows the use of one single encrypted password file using the passworddir option, pointing to a shared disk on UNIX systems.

Beginning with Tivoli Storage Manager Version 5.5, the CLUSTERnode Yes option is no longer required for correct encryption for stored passwords.

The NODename option is being used instead of retrieving the clustername from the clustering software. Use the existing cluster node name registered on the Tivoli Storage Manager server as the value for the NODename option and remove CLUSTERnode Yes.

For more information, refer to "Appendix B. Using the backup-archive client in a cluster environment" in the Tivoli Storage Manager UNIX and Linux Backup-Archive Clients Installation User's Guide.

Chapter 4. Understanding interoperability, section "Backing up multiple nodes with client node proxy support"

The following information was added at the end of the section.

Use the following procedure to store independent passwords locally on each node and still use PASSWORDAccess generate.

The following steps must be performed by the Tivoli Storage Manager server administrator:

1. Register the agent client nodenames for the standby cluster nodes.
2. The Tivoli Storage Manager runs the following command:

GRant PROXynode TArget=original_node_name
AGent=standby_node_name1(,standby_node_name2,...)

The following steps must be performed on the Tivoli Storage Manager client system:

1. For the target node, add the following options into the respective stanza of dsm.sys:

 PASSWORDAccess generate
 NODename original_node_name
 PASSWORDDIR local_writeable_directoryname

2. For the agent nodes, add the following options into the respective stanza of dsm.sys:

 PASSWORDAccess generate
 NODename standby_node_name
 ASNODEname original_node_name
 PASSWORDDIR local_writeable_directoryname

Now when you run your password setting utility for each node, these passwords will be encrypted, stored and maintained locally on each target and agent node independently from each other, without any need to obtain cluster information.