Tivoli Header

Tivoli Storage Manager Using the Application Program Interface

dsmSetAccess

The dsmSetAccess function call gives other users or nodes access to backup versions or archived copies of your objects, access to all your objects, or access to a selective set. When you give access to another user, that user can query, restore, or retrieve your files. This command supports wildcards for the following fields: fs, hl, ll, node, owner.

Note:
You cannot give access to both backup versions and archive copies by using a single command. You must specify either backup or archive.

Syntax

dsInt16_t DSMLINKAGE dsmSetAccess
        (dsUint32_t          dsmHandle,
         dsmSetAccessType    accessType,
         dsmObjName          *objNameP,
         char                *node,
         char                *owner);

Parameters

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

dsmAccessType accessType (I)
This parameter specifies the type of objects for which you want to give access. Possible values include:
atBackup Specifies that access is being set to backup objects.
atArchive Specifies that the access is being set for archive objects.

dsmObjName *objNameP (I)
This parameter is a pointer to the structure that contains the filespace name, the high-level object name, and the low-level object name.
Note:
To specify all filespaces, use an asterisk (*) for the filespace name.

char *node (I)
This parameter is a pointer to the node name for which access is given. For any node, specify an asterisk (*).

char *owner (I)
This parameter is a pointer to the user name on the node to which you gave access. For all users, specify an asterisk (*).

Return Codes

The return code numbers are provided in parentheses ( ).

Table 43. Return Codes for dsmSetAccess

Return Code Explanation
DSM_RC_INVALID_ACCESS_TYPE Invalid access type specified.
DSM_RC_FILE_SPACE_NOT_FOUND (124) Specified filespace was not found on the server.
DSM_RC_QUERY_COMM_FAILURE Communication error during server query.
DSM_RC_NO_FILES_BACKUP No files were backed up for this file space.
DSM_RC_NO_FILES_ARCHIVE No files were archived for this file space.
DSM_RC_INVALID_SETACCESS Invalid formulation of set access.


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