Return codes for IBM MQ Managed File Transfer

IBM® MQ Managed File Transfer commands, Ant tasks, and log messages provide return codes to indicate whether functions have successfully completed.

The following table lists the product return codes with their meanings:

Table 1. Return codes
Return code Short name Description
0 Success The command was successful
1 Command unsuccessful The command ended unsuccessfully.
2 Command timed out The agent did not reply with the status of the command within a specified timeout. By default, this timeout is unlimited for managed call and transfer commands. For example, when you specify the -w parameter with the fteCreateTransfer command. By default, this timeout is 5 seconds for other commands.
3 Acknowledgement timed out The agent did not acknowledge receipt of the command within a specified timeout. By default, this timeout is 5 seconds.
4 Wrong agent The command was sent to the wrong agent. The agent specified in the command XML is not the agent that is reading the command queue, on which the message was placed.
20 Transfer partially successful The transfer completed with partial success and some files were transferred.
21 Transfer stopped The transfer was stopped by one of the user exits.
22 Cancel transfer timed out The agent received a request to cancel a transfer but the cancellation could not be completed within 30 seconds. The transfer was not canceled.
26 Cancel ID not found The agent received a request to cancel a transfer but the transfer cannot be found. This might be because the transfer completed before the cancel request was processed by the agent. It might also be caused because you supplied an incorrect transfer ID to the fteCancelTransfer command. The cancel request was ignored.
27 Cancel in progress The agent received a request to cancel a transfer, but the transfer is already in the process of being canceled. The new cancel transfer request was ignored.
40 Failed The transfer failed and none of the files specified were transferred.
41 Cancelled The transfer was canceled.
42 Trigger failed The transfer did not take place because the transfer was conditional and the required condition was not met.
43 Malformed XML An XML message was malformed.
44 Source agent capacity exceeded The source agent did not have sufficient capacity to carry out the transfer.
45 Destination agent capacity exceeded The destination agent did not have sufficient capacity to carry out the transfer.
46 Source agent maximum number of files exceeded The number of files being transferred exceeded the limit of the source agent.
47 Destination agent maximum number of files exceeded The number of files transferred exceeded the limit of the destination agent.
48 Invalid log message attributes A log message is malformed. This error is an internal error. If you receive this return code contact the IBM support center for further assistance.
49 Destination unreachable The source agent is unable send a message to the destination agent due to a WebSphere® MQ problem. For example if the source agent queue manager has not been configured correctly to communicate with the destination agent queue manager.
50 Trial version violation An attempt was made by a trial version agent to communicate with an agent that is not a trial version agent.
51 Source transfer not permitted The maxSourceTransfers agent property has been set to 0. It is not permitted for this agent to be the source of any transfers.
52 Destination transfer not permitted The maxDestinationTransfers agent property has been set to 0. It is not permitted for this agent to be the destination for any transfers.
53 Not authorized The user is not authorized to perform the operation. See the accompanying message for further details.
54 Authority levels do not match The authorityChecking agent property value of the source agent and destination agent do not match.
55 Trigger not supported An attempt has been made to create a transfer with a trigger on a protocol bridge agent. This behavior is not supported.
56 Destination file to message not supported The destination agent does not support writing the file to a destination queue
57 File space not supported The destination agent does not support file spaces.
58 File space rejected The file space transfer was rejected by the destination agent.
59 Destination message to file not supported The destination agent does not support message-to-file transfers.
60 File space lookup exception The Web Gateway agent file space lookup was unsuccessful.
61 File space not found exception The Web Gateway agent found no data in the database.
62 File space not authorized exception The Web Gateway agent file space user is not authorized by the permissions database to complete the transfer.
63 File space delete action exception The Web Gateway agent file space is being deleted by the Web Gateway.
64 Both queues disallowed The source and destination of a transfer is a queue.
65 General data queue error An error occurred when the IBM MQ Managed File Transfer agent data queue was accessed.
66 Data queue put authorization error An error occurred when the IBM MQ Managed File Transfer agent data queue was accessed. WebSphere MQ Advanced Message Security is not enabled.
67 Data queue put AMS error An authorization error occurred when the IBM MQ Managed File Transfer agent data queue was accessed. WebSphere MQ Advanced Message Security is enabled.
68 Transfer not supported An attempt has been made to create a transfer that is not supported by a web agent. A web agent supports only transfers where it acts as the destination agent and the destination is a file space.
100 Monitor substitution not valid The format of a variable substitution within a monitor task XML script was malformed.
101 Monitor resource incorrect The number of monitor resource definitions was not valid.
102 Monitor trigger incorrect The number of monitor trigger definitions was not valid.
103 Monitor task incorrect The number of monitor task definitions was not valid.
104 Monitor missing The requested monitor is not present.
105 Monitor already present The requested monitor is already present.
106 Monitor user exit error A monitor user exit has generated an error during a resource monitor poll.
107 Monitor user exit canceled A monitor user exit has requested a transaction to be canceled.
108 Monitor task failed A monitor task has failed to complete due to error in processing the task.
109 Monitor resource failed A monitor resource definition cannot be applied to the given resource.
110 Monitor task variable substitution failed A variable has been specified in a monitor task but no matching name has been found in the metadata. Therefore the variable cannot be substituted with a value.
111 Monitor task source agent not valid The source agent of the monitor transfer task does not match the agent of the resource monitor.
112 Monitor task source queue manager not valid The source agent queue manager of the monitor transfer task does not match the agent queue manager of the resource monitor.
113 Monitor not supported An attempt has been made to create or delete a resource monitor on a protocol bridge agent or web agent. This behavior is not supported.
114 Monitor resource denied The directory that is scanned by the monitor resource is denied access.
115 Monitor resource queue in use The monitor resource queue is already open, and is not compatible for input with shared access.
116 Monitor resource queue unknown The monitor resource queue does not exist on the associated queue manager of the monitor.
118 Monitor resource expression invalid An error occurred evaluating the XPath expression. The XPath expression is evaluated to access the user defined properties in the header of the message. The message is on a queue which is monitored by the resource monitor.
119 Monitor task source agent queue manager missing The source agent name or source agent queue manager name is missing from the monitor task definition.
120 Monitor queue not enabled The monitor resource queue is not enabled.
121 Unexpected error when accessing monitor queue An unexpected error occurred when accessing the monitor resource queue.
122 Monitor command queue not enabled for context id The monitor agent command queue is not enabled for set context identification.

The following table lists the product intermediate reply codes with their meanings:

Table 2. Intermediate reply codes
Reply code Short name Description
-2 ACK The request has been received but is pending completion.
-3 PROGRESS The request is for a number of files and some are still pending completion.
Note:

Reply codes are only present if the process that generates the request supplies a reply queue. These are intermediate replies and IBM MQ Managed File Transfer commands return the final reply code only.