Transcription
IBM Tivoli Storage ManagerVersion 7.1Client Messages and ApplicationProgramming Interface Return Codes
IBM Tivoli Storage ManagerVersion 7.1Client Messages and ApplicationProgramming Interface Return Codes
Note:Before using this information and the product it supports, read the information in “Notices” on page 349.First edition (December 2013)This edition applies to version 7, release 1, modification 0 of IBM Tivoli Storage Manager (product numbers5608-E01, 5608-E02, 5608-E03, 5608-E07) and to all subsequent releases and modifications until otherwise indicatedin new editions. Copyright IBM Corporation 1993, 2013.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.
ContentsAbout this publication. . . . . . . . v. v. vAppendix B. Accessibility features forthe Tivoli Storage Manager productfamily. . . . . . . . . . . . . . . 347Chapter 1. Introduction to messages . . 1Notices . . . . . . . . . . . . . . 349Who should read this guide .Publications . . . . . .Tivoli Storage Manager server and client messagesformat . . . . . . . . . . . . . . .Interpreting return code messages . . . . . .Example one for QUERY EVENT command . .Example two for DEFINE VOLUME command .1233Chapter 2. ANS 0000-9999 messages . . 5ANS messages list. 5Chapter 3. API return codes . . . . . 305API return code format .API return codes . . . 305. 305Appendix A. Tivoli supportinformation . . . . . . . . . . . . 341Communities and other learning resources .Searching knowledge bases . . . . . . .Searching the Internet . . . . . . .Using IBM Support Assistant . . . . .Finding product fixes. . . . . . . .Receiving notification of product fixes . .Contacting IBM Software Support . . . .Setting up and managing support contractsDetermining the business impact . . . .Describing the problem and gatheringbackground information . . . . . . .Submitting the problem to IBM SoftwareSupport . . . . . . . . . . . . Copyright IBM Corp. 1993, 2013.341343343343344344344345345. 345. 346Trademarks . . . . . . .Privacy policy considerations . 351. 351Glossary . . . . . . . . . . . . . i
ivIBM Tivoli Storage Manager: Client Messages and Application Programming Interface Return Codes
About this publicationIBM Tivoli Storage Manager is an enterprise-wide storage managementapplication for the network. It provides automated storage management services tomulti-vendor workstations, personal computers, and local area network (LAN) fileservers.This publication contains explanations and suggested actions for messages issuedby the Tivoli Storage Manager client components:v Administrative clientv Backup-Archive clientv Space Management (Hierarchical storage management (HSM) client for UNIXand Linux)v Application programming interface (API)Who should read this guideThe target audience for this publication is system administrators who service theIBM Tivoli Storage Manager components. In this publication, it is assumed thatyou have a working knowledge of the Tivoli Storage Manager backup-archiveclient.PublicationsPublications for the Tivoli Storage Manager family of products are available online.The Tivoli Storage Manager product family includes IBM Tivoli StorageFlashCopy Manager, IBM Tivoli Storage Manager for Space Management, IBMTivoli Storage Manager for Databases, and several other storage managementproducts from IBM Tivoli.To search across all publications or to download PDF versions of individualpublications, go to the Tivoli Storage Manager information center ou also can find the Tivoli Storage Manager product family information centersand other information centers that contain official product documentation forcurrent and previous versions of Tivoli products at Tivoli Documentation Central.Tivoli Documentation Central is available at home/wiki/Tivoli Documentation Central. Copyright IBM Corp. 1993, 2013v
viIBM Tivoli Storage Manager: Client Messages and Application Programming Interface Return Codes
Chapter 1. Introduction to messagesMessages, error codes, and return codes are issued by the IBM Tivoli StorageManager server and clients.Messages and codes can appear on the server console, the administrative client, anoperator terminal, the administrative graphical user interface, the backup-archiveclient, or the HSM (Hierarchical Storage Management) client.Tivoli Storage Manager provides an activity log to help the administrator trackserver activity and monitor the system. The activity log contains messagesgenerated by the server, and is stored in the database. The server automaticallydeletes messages from the activity log after they have passed the specifiedretention period. Any messages sent to the server console are stored in the activitylog. Examples of the types of messages stored in the activity log include:v When client sessions start or endv When migration starts or endsv When backed up files are expired from server storagev Any output generated from background processesSee the IBM Tivoli Storage Manager Administrator's Guide for more informationabout activity logs.Some messages have no explanations and are not published. The client can sendstatistics to the server providing information about a backup or restore. Thesestatistics are informational messages that can be enabled or disabled to the variousevent logging receivers. These messages are not published.Tivoli Storage Manager server and client messages formatTivoli Storage Manager server and client messages consist of the followingelements:v A three-letter prefix. Messages have different prefixes to help you identify theTivoli Storage Manager component that issues the message. Typically, allmessages for a component have the same prefix. Sometimes a component issuesmessages with two or three different prefixes.For example, backup-archive clients issue messages with ANS prefix.Backup-archive client events that are logged to server have ANE prefix. Servercommon and server platform-specific messages have ANR prefix.v A numeric message identifier.v A one-letter severity code. The following codes indicate the severity of the actionthat generated the message. The severity codes and their meanings are asfollows:CodeSSeveritySevereEErrorWWarning Copyright IBM Corp. 1993, 2013MeaningThe product or a product function cannot continue. Userresponse is required.An error is encountered during processing. Processing mightstop. User response might be required.Processing continues, but problems might occur later as a resultof the warning.1
CodeISeverityInformationMeaningProcessing continues. User response is not necessary.v Message text that is displayed on screen and written to message logs.v Explanation, System Action, and User Response texts. These texts elaborate onthe message text, and are available in the product's messages publications and inthe command line help.The following image presents a typical Tivoli Storage Manager server message.The callouts identify each element of the message.Message PrefixMessage NumberMessage Type*ANR 0992 IServer installation complete.Message TextExplanation: The server installation procedurehas completed successfully. The server is nowavailable for normal operation.ExplanationSystem Action: Server completes installationprocessing.System ActionUser Response: None.User Response* I InformationE ErrorS Severe ErrorW WarningK Kernel message that originates from thehierarchical storage management (HSM) clientMessage variables in the message text appear in italics.Interpreting return code messagesMany different commands can generate the same return code. The followingexamples are illustrations of two different commands issued that result in the samereturn code; therefore, you must read the descriptive message for the command.In these examples, two different commands yield the same return code, but theyalso return descriptive messages that are unique to each command. The twocommands are q event standard dddd and def vol cstg05 primary. Both yield ageneric message with return code:ANS5102I: Return Code 11.But the first command also yields a descriptive message:ANR2034I: QUERY EVENT: No match found for this query.And the second command also yields a unique, descriptive message:ANRxxxx: DEFINE VOLUME: Storage pool CSTG05 is not defined.2IBM Tivoli Storage Manager: Client Messages and Application Programming Interface Return Codes
Example one for QUERY EVENT commandExample two for DEFINE VOLUME commandChapter 1. Introduction to messages3
4IBM Tivoli Storage Manager: Client Messages and Application Programming Interface Return Codes
Chapter 2. ANS 0000-9999 messagesANS messages with message numbers in the range 0000-9999 are issued by thefollowing IBM Tivoli Storage Manager clients:v Administrative clientsv Application programming interface clientsv Backup–archive clientsv Tivoli Storage Manager for Space management (HSM) clientsANS messages listIBM Tivoli Storage Manager V7.1 client messages are listed in ascending numericorder. The complete message is documented, including message ID, message text,explanation, system action, and user response.ANS0101EUnable to open English messagerepository file name.Explanation: The default English message repositoryfile cannot be opened. Either the file access permissionsprevent reading the file or the file is not present in theexpected location.System action: TSM is unable to complete therequested operation. Processing is terminated.User response: Make sure the file in your DSM DIR isset up properly. If the problem continues, see yoursystem administrator for further help.ANS0102WUnable to open the message repositoryfile name. The American Englishrepository will be used instead.Explanation: The default message repository file forthe current locale cannot be opened. Either the fileaccess permissions prevent reading the file, the file isnot present in the expected location, or the languagespecified in the option file is not supported on thisworkstation.System action: TSM continues processing using theEnglish language message repository.User response: Make sure the file in your DSM DIR isset up properly. If the problem continues, see yoursystem administrator for further help.ANS0103EError trying to read header record frommessage repository file name.Explanation: The message repository file headerrecord cannot be obtained.System action: TSM is unable to complete therequested operation.from the installation. If the problem continues, see yoursystem administrator for further help.ANS0105EError trying to read index for messagenumber from repository file name.Explanation: The message text for the specifiedmessage number cannot be read.System action: TSM is unable to complete therequested operation.User response: Make sure the file has not been alteredfrom the installation. If the problem continues, see yoursystem administrator for further help.ANS0106EMessage index not found for messagenumber.Explanation: The message repository file does notcontain the message text for the message number.System action: TSM is unable to complete therequested operation.User response: Make sure the DSM DIR is set upproperly and it does not point to an old copy. If theproblem continues, see your system administrator forfurther help.ANS0107EError trying to read header for messagenumber from repository file name.Explanation: The message header information cannotbe obtained for the message number in the messagefile.System action: TSM is unable to complete therequested operation.User response: Make sure the file has not been alteredfrom the installation. If the problem continues, see yourUser response: Make sure the file has not been altered Copyright IBM Corp. 1993, 20135
ANS0108E ANS0201Esystem administrator for further help.ANS0108EError trying to read text for messagenumber from repository file name.Explanation: The message text cannot be obtained forthe message number in the message file.System action: TSM is unable to complete therequested operation.User response: Make sure the file has not been alteredfrom the installation. If the problem continues, see yoursystem administrator for further help.ANS0109EInsufficient memory for allocation ofmessage structure.Explanation: There is not enough memory in yoursystem to allocate the storage needed for the messagetext.User response: Stop TSM and restart TSM. Then retrythe operation. If unsuccessful, make sure the file hasnot been locked by another application.ANS0119EExplanation: The response string information for themessage number cannot be obtained from the messagerepository file. It is possible the message repository hasbeen corrupted.System action: TSM is unable to complete therequested operation.User response: Make sure the message file was notaltered from the installation. Check DSM DIR to makesure it is set up properly.ANS0120ESystem action: TSM is unable to complete therequested operation.User response: Stop TSM and restart TSM. Then retrythe operation. If unsuccessful, close all unneededapplications and retry the operation.ANS0110EUnable to open error log file file namefor output.Explanation: The error log cannot be opened foroutput.System action: TSM is unable to complete therequested operation. File permissions may be set suchthat writing is not allowed.User response: Stop and restart TSM. Then retry theoperation. If unsuccessful, make sure the file is notbeing locked by another application and that filepermissions allow write access.ANS0113EMessage repository file name has aninvalid control record.Error trying to read response string formessage number from repository filename.Message number number contains aninvalid multibyte sequence for thecurrent locale.Explanation: An illegal multibyte sequence for thecurrent locale was found in the message. Either themessage repository has been corrupted or is coded in alanguage other than that of the current locale.System action: TSM is unable to complete therequested operation.User response: If the message repository is notcorrupted, process the operation in the supportedlocale.ANS0121WUnable to open the iconv converter forthe message repository file name. TheAmerican English repository will beused instead.Explanation: The iconv converter for the defaultmessage repository for the current locale cannot beopened. The iconv converter used to convert fromUTF-8 to the current locale is not installed on this workstation.Explanation: The message repository file contains anincorrect control information.System action: TSM continues processing using theEnglish language message repository.System action: TSM is unable to complete therequested operation.User response: Make sure the required iconvconverter is installed properly. If the problemcontinues, see your system administrator for furtherhelp.User response: Make sure the message file was notaltered from the installation. Check DSM DIR to makesure it is set up properly.ANS0201EANS0118EUnable to open schedule log file 'filename' for output.Explanation: The schedule log file cannot be openedfor output.Invalid parameter was found.Explanation: The system encountered an internalprogram error due to an invalid parameter.System action: The system returns to the callingprocedure.System action: TSM is unable to complete therequested operation.6IBM Tivoli Storage Manager: Client Messages and Application Programming Interface Return Codes
ANS0202E ANS0212EUser response: Ask your service representative tocheck the error log.ANS0202ENot authorized to restore the othernode's data.Explanation: The client is not authorized to restore theother node's data.System action: The system returns to the callingprocedure.ANS0207EThe log file name was not specified.Explanation: The system is unable to open the errorlog file.System action: The system returns to the callingprocedure.User response: Verify the DSMI LOG value andaccess permission. On the AS/400 platform, verify thevalue specified for ERRORLOGNAME in the APIoptions file.User response: Get authorization from the other node.ANS0208EANS0203EThe objName field has no leadingdirectory separator.Explanation: The objName field does not have aleading directory separator.System action: The system returns to the callingprocedure.User response: Correct the value for the objName.ANS0204EWildcards are not allowed in theobjName directory path.Explanation: Wildcards are not allowed in theobjName directory path.System action: The system returns to the callingprocedure.User response: Correct the value for the objName.ANS0205EUnable to open error log file.Explanation: The system is unable to open the errorlog file.System action: The system returns to the callingprocedure.User response: Verify the DSMI LOG value andaccess permission. On the AS/400 platform, verify thevalue specified for ERRORLOGNAME in the APIoptions file.ANS0206EThe log file cannot be written to.Explanation: There was an error writing to the logfile.System action: The system returns to the callingprocedure.User response: Verify the DSMI LOG value andaccess permission. on the AS/400 platform, verify thevalue specified for ERRORLOGNAME in the APIoptions file.The TCP/IP WINSOCK.DLL file cannotbe found.Explanation: The TCP/IP WINSOCK.DLL file cannotbe found.System action: Processing stopped.User response: Verify your TCP/IP installation.ANS0209EAn error occurred while loading alibrary.Explanation: An error occurred while loading alibrary. The TCP/IP DLL load failed.System action: Processing stopped.User response: Verify your TCP/IP installation.ANS0210EThe TCP/IP load function failed.Explanation: An error occurred while locating afunction. The TCP/IP load function failed.System action: Processing stopped.User response: Verify your TCP/IP installation.ANS0211EThe object name pointer is NULL.Explanation: There is no value provided for the objectname pointer.System action: The system returns to the callingprocedure.User response: Provide an address for thedsmObjName structure.ANS0212EThe data block pointer is NULL.Explanation: There is no value provided for the datablock pointer.System action: The system returns to the callingprocedure.User response: Provide an address for the DataBlkstructure.Chapter 2. ANS 0000-9999 messages7
ANS0213E ANS0223EANS0213EThe object attribute pointer is NULL.Explanation: There is no value provided for the objectattribute pointer.System action: The system returns to the callingprocedure.User response: Provide an address for the ObjAttrstructure.ANS0219EExplanation: The dsmEndTxn vote is invalid.System action: The system returns to the callingprocedure.User response: The vote must beDSM VOTE COMMIT or DSM VOTE ABORT.ANS0220EANS0214EThere is no server session information.Explanation: The server did not respond with thesession information.System action: The system returns to the callingprocedure.User response: Verify the server status.ANS0215EThere is no server policy information.Explanation: The server did not respond with thepolicy information.System action: The system returns to the callingprocedure.User response: Verify the server policy definitions.ANS0216EThe dataBlk bufferLen value is zero.Explanation: The value for the dataBlk bufferLen iszero.System action: The system returns to the callingprocedure.User response: Provide a non-zero value for thebufferLen.The dsmEndTxn vote is invalid.An invalid option was found duringoption parsing.Explanation: An invalid option was found.System action: The system returns to the callingprocedure.User response: Verify the options in dsm.opt, dsm.sys,and the options string. Check the error log for moredetails about the error. on the AS/400 platform, verifythe options in *LIB/QOPTTSM(APIOPT).ANS0221EThere was an error in the TSM APIinternals.Explanation: The system encountered an error in theAPI internals.System action: The system returns to the callingprocedure.User response: Shut down the process and retry theoperation. Verify that any previous dsmInit calls werecleaned up and terminated by a dsmTerminate call. Ifthe problem continues, contact your systemadministrator or service representative.ANS0222EThe repository type is invalid.Explanation: The repository type is invalid.ANS0217EThe dataBlk bufferPtr is NULL.Explanation: There is no value provided for thedataBlk bufferPtr.System action: The system returns to the callingprocedure.User response: Provide an address for the bufferPtr.ANS0218EThe objType is invalid.Explanation: The value for the objType is invalid.System action: The system returns to the callingprocedure.User response: The value for dsmObjName.objTypemust be:v DSM OBJ FILE or DSM OBJ DIRECTORY forBackup, orSystem action: The system returns to the callingprocedure.User response: For dsmDeleteFS the repository mustbe one of the following:v DSM ARCHIVE REPv DSM BACKUP REPv DSM REPOS ALL.ANS0223EFilespace name should start with thedirectory delimiter.Explanation: The filespace name is invalid.System action: The system returns to the callingprocedure.User response: Filespace name should start with thedirectory delimiter.v DSM OBJ FILE for Archive.8IBM Tivoli Storage Manager: Client Messages and Application Programming Interface Return Codes
ANS0224E ANS0233EANS0224EThe object name is either an emptystring or has no leading delimiter.Explanation: The object name is invalid because of anempty string or there is no leading delimiter.System action: The system returns to the callingprocedure.User response: Verify the format of the dsmObjNamefull path.ANS0225ELow level qualifier of the object nameshould start with the directory delimiter.Explanation: The low level qualifier for the objectname is invalid.System action: The system returns to the callingprocedure.User response: Start the low level qualifier of theobject name with the directory delimiter.ANS0226EThe object owner is invalid.ANS0229EThe dsmDeleteObj delType is invalid.Explanation: The dsmDeleteObj delType is invalid.System action: The system returns to the callingprocedure.User response: The delType must be dtBackup ordtArchive.ANS0230EThe query Backup objState is invalid.Explanation: The query Backup objState is invalid.System action: The system returns to the callingprocedure.User response: The qryBackupData.objState must beone of the following:v DSM ACTIVEv DSM INACTIVEv DSM ANY MATCHANS0231EThe management class name was notfound.Explanation: The object owner must be either the rootuser, or the object owner must be the same as thesession owner.Explanation: A query or send operation is unable tofind the management class name.System action: The system returns to the callingprocedure.System action: The system returns to the callingprocedure.User response: Verify the session owner and objectowner.User response: Verify the management class name.ANS0232EANS0227EThe dsmBindMC sendType is invalid.Explanation: The dsmBindMC sendType is invalid.System action: The system returns to the callingprocedure.User response: The sendType must be one of thefollowing:v stBackupv stArchiveThe drive letter is not an alphabeticcharacter.Explanation: The drive letter is not an alphabeticcharacter. This return code is valid on MicrosoftWindows only.System action: The system returns to the callingprocedure.User response: Verify that the drive designation is analphabetic character. The referenced field isdsmDosFSAttrib.driveLetter.v stBackupMountWaitv stArchiveMountWaitANS0233EANS0228EExplanation: There is no value provided for theRegister Filespace name.The dsmSendObj sendType is invalid.Explanation: The dsmSendObj sendType is invalid.System action: The system returns to the callingprocedure.User response: The sendType must be one of thefollowing:The Register Filespace name is NULL.System action: The system returns to the callingprocedure.User response: Provide a filespace name ondsmRegisterFS.v stBackupv stArchivev stBackupMountWaitv stArchiveMountWaitChapter 2. ANS 0000-9999 messages9
ANS0234E ANS0243EANS0234EThe new password value is NULL orblank.Explanation: There is no value provided for newpassword.ANS0238EThe sequence of calls is invalid.Explanation: The sequence of calls is invalid.System action: The system returns to the callingprocedure.System action: The system returns to the callingprocedure.User response: Verify the transaction call sequence.User response: Provide a new password ondsmChangePW.ANS0239EANS0235EExplanation: On dsmSendObj, wildcards are notallowed for the objName.The old password value is NULL orblank.Explanation: There is no value provided for oldpassword.System action: The system returns to the callingprocedure.User response: Provide an old password ondsmChangePW.ANS0236EOn dsmInit, the owner is not allowed toestablish a session whenPASSWORDACCESS generate.Explanation: PASSWORDACCESS GENERATEestablishes a session with the current login user as theowner. The application should set clientOwnerNamePto NULL when PASSWORDACCESS GENERATE is ineffect.System action: The system returns to the callingprocedure. Whether the application can continueprocessing depends on how the application handles theerror.User response: This message applies to applicationsthat utilize the TSM API, and is intended primarily forthe vendor of the application for which the message isissued. Depending on the application, this could be aconfiguration issue.On dsmSendObj, wildcards are notallowed for the objName.System action: The system returns to the callingprocedure.User response: Provide a fs, hl, and ll on thedsmObjName.ANS0240EThe filespace to delete/set access cannotbe found.Explanation: The filespace to delete cannot be found.System action: The system returns to the callingprocedure.User response: Verify the filespace name.ANS0241EOn dsmSendObj, dsmDeleteObj, ordsmUpdateFS the filespace is notregistered.Explanation: On dsmSendObj, dsmDeleteObj, ordsmUpdateFS, the filespace is not registered.System action: The system returns to the callingprocedure.User response: Verify the filespace name.ANS0242WOn dsmRegisterFS the filespace isalready registered.Consult the documentation for the application andverify that the application is configured correctly. If theproblem persists, contact the application vendor forfurther assistance.Explanation: On dsmRegisterFS the filespace isalready registered.ANS0237EUser response: Verify the filespace name.On dsmInit, the node is not allowedwhen PASSWORDACCESS generate.Explanation: PASSWORDACCESS generateestablishes a session with the current hostname as thenode.System action: The system returns to the callingprocedure.User response: When usingPASSWORDACCESS generate, set clientNodeNameP toNULL.System action: The system returns to the callingprocedure.ANS0243EOn dsmBeginGetData the objID isNULL.Explanation: On dsmBeginGetData, the objID isNULL.System action: The system returns to the callingprocedure.User response: Verify the following:v The dsmGetList is not NULL.v Each objID is not NULL.10IBM Tivoli Storage Manager: Client Messages and Application Programming Interface Return Codes
ANS0244E ANS0254Ev The dsmGetList numObjId is not zero.ANS0244EOn dsmInit the caller's API version isdifferent than the TSM library version.Explanation: On dsmInit the caller's API version has ahigher value than the TSM library version.ANS0249EThe archive object does not have a copygroup.Explanation: The archive object does not have a copygroup.System action: The system returns to the callingprocedure.System action: The system returns to the callingprocedure.User response: Verify server policy definitions.User response: Install the latest TSM API library andtrusted agent module.ANS0250EANS0245EExplanation: Memory used by the TSM API has beencorrupted.The caller's structure version is differentthan the TSM library version.Explanation: The caller's structure version is differentthan the TSM library version.System action: The system returns to the callingprocedure.User response: Ensure that the stVersion field is setwith the value in the header file. Recompile theapplication with the latest header files.ANS0246EIssue dsmEndTxn and then begin a newtransaction session.Explanation: This transaction must be ended and anew one must be started due to one of the followingreasons:v The destination changed.Memory used by the TSM API has beencorrupted.System action: The system returns to the callingprocedure.User response: Retry the operation. If the problemcontinues, contact your system administrator or servicerepresentative.ANS0251EThe sendObj Archive description is toolong.Explanation: The sendObj Archive description is toolong.System action: The system returns to the callingprocedure.User response: The sndArchiveData.descr string mustbe less than or equal to DSM MAX DESCR LENGTH.v The byte limit is exceededv The maximum number of objects is exceeded.ANS0252ESystem action: The system returns to the callingprocedure.Explanation: The sendObj ObjAttr.objInfo is too long.User response: Issue dsmEndTxn and start a newtransaction session.System action: The system returns to the callingprocedure.ANS0247EUser response: The objInfo field must be less than orequal to DSM MAX OBJINFO LENGTH.The backup or archive object isexcluded from processing.The sendObj ObjAttr.objInfo is toolong.Explanation: The backup or archive object is excludedfrom proce
IBM Tivoli Storage Manager components. In this publication, it is assumed that you have a working knowledge of the Tivoli Storage Manager backup-archive client. Publications Publications for the Tivoli Storage Manager family of products are available online. The Tivoli Storage Manager product family includes IBM Tivoli Storage
