Tivoli Header

Tivoli Storage Manager Using the Application Program Interface

dsmDeleteFS

Note:
On a UNIX operating system, only a root user or a TSM-authorized user can delete a file space.

The dsmDeleteFS function call deletes a filespace from storage. To delete a filespace, you must have the appropriate permissions that your TSM administrator gave you. To determine whether you have the necessary permissions, call dsmQuerySessInfo. This function call returns a data structure of type ApiSessInfo, that includes two fields, archDel and backDel.

If the filespace that you need to delete contains backup versions, you must have backup delete authority (backDel = BACKDEL_YES). If the filespace contains archive copies, you must have archive delete authority (archDel = ARCHDEL_YES). If the file space contains both backup versions and archive copies, you must have both types of delete authority.

Syntax

dsInt16_t dsmDeleteFS  (dsUint32_t          dsmHandle,
   char           *fsName,
   unsigned char   repository);

Parameters

dsUint32_t dsmHandle (I)
The handle that associates this call with a previous dsmInitEx call.

char *fsName (I)
A pointer to the filespace name to delete. The wildcard character is not permitted.

unsigned char repository (I)
Indicates whether the file space to delete is a backup repository, archive repository, or both. The possible values for this field include:
DSM_ARCHIVE_REP     /* archive repository   */
DSM_BACKUP_REP      /* backup repository    */
DSM_REPOS_ALL       /* all repository types */

Return Codes

The return code numbers are provided in parentheses ( ).

Table 21. Return Codes for dsmDeleteFS

Return Code Explanation
DSM_RC_ABORT_NOT_AUTHORIZED (27) You do not have the necessary authority to delete the filespace.
DSM_RC_INVALID_REPOS (2015) Invalid value for repository.
DSM_RC_FSNAME_NOTFOUND (2060) Filespace name not found.
DSM_RC_NEED_ROOT (2300) API caller must be a root user.


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