TCPL0100 format usage notes

 

TCPL0100 is one of the exit point formats that is used for both the File Transfer Protocol (FTP) Server Logon exit point and the Remote Execution Protocol (REXEC) Server Logon Validation exit point.

For File Transfer Protocol (FTP), if any of the returned output parameters are not valid, the FTP server will not allow the operation. In this case, the FTP server issues the message Data from exit program for exit point &1 is missing or not valid to the job log.

For FTP, if you encounter any exception when you call the exit program, the FTP server issues this message: Exception encountered for FTP exit program &1 in library &2 for exit point &3

This table summarizes what the FTP server will do, depending on the value of the return code (parameter 8) that is returned to the FTP server by the exit program.

A value of 'Return value' indicates that the exit program must return the appropriate value for that output parameter. The value will then be used by the FTP server to complete the logon request process.

Return code User profile (9) Password (10) Initial lib (11)
0 Ignored Ignored Ignored
1 (User identifier, parameter 2) (Password, parameter 4) (From user profile)
2 (User identifier, parameter 2) (Password, parameter 4) Return value
3 Return value Return value (From user profile)
4 Return value Return value Return value
5 Return value Ignored (From user profile)
6 Return value Ignored Return value

In the table above, the values in parentheses indicate what the TCP/IP application uses for information when it ignores the output value. The entry Ignored means that it used no value; therefore return nothing for that return code value.

For the FTP server (exit point QIBM_QTMF_SVR_LOGON, application identifier 1): when the user identifier is ANONYMOUS and this exit point adds the exit program, the FTP server issues this special reply when requesting the password: 331 Guest logon in process, send complete e-mail address as password. The application issues this message before calling the exit program.

After the application accepts the FTP server logon, the FTP server issues this reply: 230 Guest logon accepted, access restrictions apply

 

REXEC server (application identifier 2):

  1. If the return allow operation output parameter is not valid, the REXEC server will not allow the operation. The REXEC server issues the message "Data from exit program for exit point &1 is missing or not valid" to the job log.

  2. If the REXEC server encounters any exception when calling the exit program, the REXEC server will not allow the operation. It issues the message "Exception encountered for REXEC exit program &1 in library &2 for exit point &3," to the job log.

 

Parent topic:

TCPL0100 exit point format