IBM Version 4 Chapter 8. Use of OS/400 APIs

Chapter 8. Use of OS/400 APIs

This chapter discusses the various groups of OS/400 APIs and how they may be of

use to you. Some APIs are discussed as a group, similar to the parts in the

System API Reference

, while others are discussed individually.

The API discussions in this chapter are presented in the same order as in the

System API Reference

Use of the backup and recovery APIs is described as follows:

Operational-Assistant Backup APIs

The APIs for Operational Assistant backup have been provided to give the

users an interface into the Operational-Assistant backup setup functions without

having to go through the normal displays. One possible use of these APIs

would be to change the way the backup runs from one week to the next. For

example, the user could write a CL program that could run on those weeks in

which holidays occur to change the backup options to skip the backup for a

certain day. This CL program could be submitted to run the week of a holiday

to change the backup options to skip the backup on the holiday, and it could be

submitted to run again after that week to set the options back to normal. The

APIs could also be used to retrieve backup history about certain libraries,

folders, and so forth, in order to better tailor the backups to get the most effi-

cient backups.

Retrieve Device Capabilities (QTARDCAP) API

This API is useful for a tape management system. The API returns information

about what capabilities your tape devices support.

Save Object List (QSRSAVO) API

This API is useful to get a level of granularity from your save operations that

you cannot get by using the Save Object (SAVOBJ) command. The API allows

you to associate specific object names with specific object types instead of

saving the cross-product of all object names and object types entered on the

command.

List Save File (QSRLSAVF) API

This API lists the contents of a save file into a user space. This is primarily for

those who develop backup and recovery applications.

The client support APIs include the client software management and configuration

APIs and exit programs.

The client software management and configuration section provides APIs to add,

remove, refresh, and update client information on the AS/400 database with the

information stored at the client. The client software management database formats

are affected by these APIs. For information about these formats, see the chapter

about client inventory management in the

book, SC41-5412. The exit programs notify you when these API

functions have been completed.