Tivoli Header
Tivoli Storage Manager Using the Application Program Interface
The dsmRegisterFS function call registers a new filespace with
the TSM server. Register a filespace first before you can back up any
data to it.
Application clients should not use the same filespace names that a
backup-archive client would use.
- On UNIX, run the df command for these names.
- On Windows, these names are generally the volume labels that are
associated with the different drives on your system.
- On NetWare, these names are normally volume names. There is always
one called sys:, but other volume names can be almost
anything.
- On OS/400, there is no backup-archive client.
Syntax
dsInt16_t dsmRegisterFS (dsUint32_t dsmHandle,
regFSData *regFilespaceP);
Parameters
- dsUint32_t dsmHandle (I)
- The handle that associates this call with a previous dsmInitEx
call.
- regFSData *regFilespaceP (I)
- This parameter passes the name of the filespace and associated information
that you need to register with the TSM server.
- Note:
- The fstype field includes the prefix, API: All
filespace queries will display this string. For example, if the user
passes myfstype for fstype in dsmRegisterFS, the actual
value string on the server will return API:myfstype when
queried. This prefix distinguishes API objects from backup-archive
objects.
The usable area for fsInfo is now
DSM_MAX_USER_FSINFO_LENGTH.
Return Codes
The return code numbers are provided in parentheses ( ).
Table 39. Return Codes for dsmRegisterFS
Return Code
| Explanation
|
DSM_RC_INVALID_FSNAME (2016)
| Invalid file space name.
|
DSM_RC_INVALID_DRIVE_CHAR (2026)
| Drive letter is not an alphabetic character.
|
DSM_RC_NULL_FSNAME (2027)
| Null filespace name.
|
DSM_RC_FS_ALREADY_REGED (2062)
| Filespace is already registered.
|
DSM_RC_WRONG_VERSION_PARM (2065)
| Application client's API version is different from the TSM library
version.
|
DSM_RC_FSINFO_TOOLONG (2106)
| Filespace information is too long.
|
[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]