Tivoli Header

Tivoli Storage Manager Using the Application Program Interface

Naming Your API Objects

Establish a consistent naming convention for API object names that consist of the filespace name, the high-level qualifier, and the low-level qualifier. The filespace name and high-level qualifiers can refer to actual directory names, although this is not a requirement. Each can consist of more than one directory name that applies to the low-level qualifier. We recommend that the low-level qualifier be the name of the object that is not prefixed with directory information. See "Identifying the Object" for more information.

Filespace names must be fully qualified when they are referred from either the API or the backup-archive command line. For example, on a UNIX operating system, if you register filespace /a and another filespace, /a/b, then, when you refer to /a, it will display objects that are related only to filespace /a. To view objects that are related to /a/b, specify /a/b as the filespace name. After you register both filespaces, if you back up object b into filespace /a, then a query for /a/b will continue to display objects that are related to filespace /a/b only.

The exception to this restriction occurs in filespace references when you attempt to query or delete file spaces with the API. In both cases, it is not necessary for filespace names to be fully qualified if you use a wildcard character. For example, /a* will refer to both /a and /a/b.

Note:
If interoperability is important to you, then avoid filespace names that overlap.

On Intel-based operating systems, enclose filespace names in braces { } for API objects when you access them from the backup-archive command line. Intel-based operating systems automatically place filespace names in uppercase letters when you register or refer them. However, this is not true for the remainder of the object name specification. If you want full interoperability, place the high-level qualifier and the low-level qualifier in uppercase letters in the application when you back up API objects. The examples that follow demonstrate these concepts. In both environments, it is not necessary to specify completely either the high-level or the low-level qualifier. However, if you do not, then you must use the wildcard character.

Platform Example
Intel To query all backed-up files in filespace MYFS, enter:
   dsmc q ba "{MYFS}\*\*"
Note:
There is at least one asterisk (*) for each of the high-level and low-level qualifiers.
UNIX To query all backed-up files in filespace /A, enter:
   dsmc q ba "/A/*/*"
Note:
There is at least one asterisk (*) for each of the high-level and low-level qualifiers.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]