Converting return codes (CLIENTERRCODES)
Below lists the possible formats for FTP return codes for clients running in batch mode, as a TSO clist,
or from a REXX application.
The format of the return code is determined both by the settings on this panel and by parameters entered
on the ftp command when the user logs in. The use of the EXIT=nn ftp command parameter will
override the settings on this panel as explained below.
- Using the EXIT=nn ftp command option
- This option is set on the ftp command when the client enters the FTP environment.
This instructs the client to exit with the return set to your nn value,
when an error occurs.
Using this option on the initial ftp command overrides the "Converting return codes" settings on this panel.
Limitations
The same nn return code value is returned for all errors.
- Selecting "2 digit client error return code set"
- This option uses a set of 2 digit client error codes described in z/OS Communications Server IP User's Guide and
Commands (SC31-8780) in the section "FTP client error codes". Each 2 digit client error code is listed
with the name of the error and possible causes of the error.
Limitations
The failing subcommand is not returned.
The 3 digit reply code is not returned. It can be derived from message EZA1735I if the
ftp command option ( EXIT, ( EXIT=nn, or -e was specified,
or from message EZZ9830I if you checked the box labeled "Report errors with message EZZ9830I".
- Selecting 4 digit XXYY format; where XX is the 2 digit client error return code and YY is the FTP subcommand"
- This option returns both the 2 digit client error code and the FTP subcommand that failed. The 2 digit client error
codes are the same as those described in "2 digit client error return code set".
The complete list of 2 digit client error codes and FTP subcommands are described in z/OS Communications Server IP
User's Guide and Commands (SC31-8780). The 2 digit client error codes are in the section 'FTP client error codes' and
the FTP subcommands are found in section 'FTP subcommand codes'.
Limitations
The 3 digit reply code is not returned. It can be derived from message EZA1735I if the
ftp command option ( EXIT, ( EXIT=nn, or -e was specified,
or from message EZZ9830I if you checked the box labeled "Report errors with message EZZ9830I".
- Selecting 5 digit XXYYY format; where XX is the FTP subcommand and YYY is the FTP server reply code"
- This option returns both the FTP subcommand that failed, and a 3 digit reply code.
The FTP subcommands are described in z/OS Communications Server IP
User's Guide and Commands (SC31-8780) in section 'FTP subcommand codes'. The complete list of the 3 digit reply
codes are described in z/OS Communications Server IP and SNA Codes (SC31-8791) in the section
'FTPD reply codes'.
Limitations
- The XXYYY return code is converted to modulo 4096 for batch jobs, to fit within a 12 bit restriction.
The possible (modulo) return codes and their meanings are not documented and are difficult to convert back to
the XXYYY format.
- Many different error situations generate the same YYY reply code.
- SMF Type 30 (Step Termination) records contain the return code in hexadecimal.
However, the SMF record field for the return code
is only 2 bytes, so any XXYYY value greater than 64K is truncated.
- The return code from a batch job (modulo format) will not match the SMF format (XXYYY format).
- The return code from a batch job (modulo format) will not match the return code in the job log.
Due to the limitations, IBM does not recommend using this format.
The settings on this panel apply to interactive clients, running under TSO or the z/OS UNIX System Services shell, only if
you checked the box labeled "Report errors with message EZZ9830I". The return code format in message
EZZ9830I is shown according to the return code format selected. If ftp command option ( EXIT, ( EXIT=nn, or
-e is specified for interactive clients, errors are also reported with EZA1735I.
However, EZA1735I shows the return code values and failing subcommands in a fixed format which cannot be customized.