Tivoli Header

Tivoli Storage Manager Using the Application Program Interface

dsmChangePW

The dsmChangePW function call changes a TSM password. On a multiple-user operating system such as UNIX, only the root user or the TSM-authorized user can use this call.

On the Windows and Novell operating systems, you can specify the password in the dsm.opt file. In this situation, dsmChangePW does not update the dsm.opt file. After the call to dsmChangePW is made, you must update the dsm.opt file separately.

This call must process successfully if dsmInitEx returns DSM_RC_VERIFIER_EXPIRED. The session will end if the dsmChangePW call fails in this situation.

If dsmChangePW is called for some other reason, the session will remain open regardless of the return code.

Syntax

dsInt16_t dsmChangePW  (dsUint32_t   dsmHandle,
   char    *oldPW,
   char    *newPW);
 

Parameters

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

char *oldPW (I)
The old password of the caller. The maximum length is DSM_MAX_VERIFIER_LENGTH.

char *newPW (I)
The new password of the caller. The maximum length is DSM_MAX_VERIFIER_LENGTH.

Return Codes

The return code numbers are provided in parentheses ( ).

Table 20. Return Codes for dsmChangePW

Return Code Explanation
DSM_RC_ABORT_BAD_VERIFIER (6) An incorrect password was entered.
DSM_RC_AUTH_FAILURE (137) Authentication failure. Old password is incorrect.
DSM_RC_NEWPW_REQD (2030) A value must be entered for the new password.
DSM_RC_OLDPW_REQD (2031) A value must be entered for the old password.
DSM_RC_PASSWD_TOOLONG (2103) The specified password is too long.
DSM_RC_NEED_ROOT (2300) The API caller must be a root user or a TSM-authorized user.


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