277 lines
14 KiB
HTML
277 lines
14 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE html
|
||
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html lang="en-us" xml:lang="en-us">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<meta name="security" content="public" />
|
||
|
|
<meta name="Robots" content="index,follow" />
|
||
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
||
|
|
<meta name="DC.Type" content="reference" />
|
||
|
|
<meta name="DC.Title" content="TCPL0300 exit point format" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiqlepi.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiqftpwbi.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiql0100.htm" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2004, 2006" />
|
||
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2004, 2006" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="rzaiql0300" />
|
||
|
|
<meta name="DC.Language" content="en-us" />
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
||
|
|
<title>TCPL0300 exit point format</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzaiql0300"><a name="rzaiql0300"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">TCPL0300 exit point format</h1>
|
||
|
|
<div><div class="section"><p>Exit Point Format Name: TCPL0300<br />
|
||
|
|
Exit Point Name: QIBM_QTMF_SVR_LOGON<br />
|
||
|
|
Exit Point Name: QIBM_QTMX_SVR_LOGON</p>
|
||
|
|
<p>This is the required parameter
|
||
|
|
group.</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr valign="bottom"><th valign="bottom" id="d0e29">Parameter</th>
|
||
|
|
<th valign="bottom" id="d0e31">Description</th>
|
||
|
|
<th valign="bottom" id="d0e33">Input or output</th>
|
||
|
|
<th valign="bottom" id="d0e35">Type and length</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e29 ">1</td>
|
||
|
|
<td valign="top" headers="d0e31 ">Application identifier</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Input</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">2</td>
|
||
|
|
<td valign="top" headers="d0e31 ">User identifier</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Input</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">3</td>
|
||
|
|
<td valign="top" headers="d0e31 ">Length of user identifier</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Input</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">4</td>
|
||
|
|
<td valign="top" headers="d0e31 ">Authentication string</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Input</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">5</td>
|
||
|
|
<td valign="top" headers="d0e31 ">Length of authentication string</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Input</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">6</td>
|
||
|
|
<td valign="top" headers="d0e31 ">CCSID of authentication string</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Input</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">7</td>
|
||
|
|
<td valign="top" headers="d0e31 ">Client IP address</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Input</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">8</td>
|
||
|
|
<td valign="top" headers="d0e31 ">Length of client IP address</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Input</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">9</td>
|
||
|
|
<td valign="top" headers="d0e31 ">Allow logon</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Output</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">10</td>
|
||
|
|
<td valign="top" headers="d0e31 ">User profile</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Output</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">11</td>
|
||
|
|
<td valign="top" headers="d0e31 ">Password</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Output</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">12</td>
|
||
|
|
<td valign="top" headers="d0e31 ">Length of password</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Output</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">13</td>
|
||
|
|
<td valign="top" headers="d0e31 ">CCSID of password</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Output</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">14</td>
|
||
|
|
<td valign="top" headers="d0e31 ">Initial current library</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Input/Output</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">15</td>
|
||
|
|
<td valign="top" headers="d0e31 ">Initial home directory</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Output</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">16</td>
|
||
|
|
<td valign="top" headers="d0e31 ">Length of initial home directory</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Input/Output</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">17</td>
|
||
|
|
<td valign="top" headers="d0e31 ">CCSID of initial home directory</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Input/Output</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">18</td>
|
||
|
|
<td valign="top" headers="d0e31 ">Application-specific information</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Input/Output</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e29 ">19</td>
|
||
|
|
<td valign="top" headers="d0e31 ">Length of application-specific information</td>
|
||
|
|
<td valign="top" headers="d0e33 ">Input</td>
|
||
|
|
<td valign="top" headers="d0e35 ">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Parameter descriptions</h4><dl><dt class="dlterm">Application identifier</dt>
|
||
|
|
<dd>INPUT; BINARY(4) Identifies the application server from which the request
|
||
|
|
is being made. The valid values are:<dl><dt class="dlterm">1</dt>
|
||
|
|
<dd>FTP server program</dd>
|
||
|
|
<dt class="dlterm">2</dt>
|
||
|
|
<dd>REXEC server program</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">User identifier</dt>
|
||
|
|
<dd>INPUT; CHAR(*) The user identification supplied by the client program.<p>For
|
||
|
|
the FTP server, this parameter contains the data field from the USER subcommand.</p>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">Length of user identifier</dt>
|
||
|
|
<dd>INPUT; BINARY(4) The length (in bytes) of the user identifier string.</dd>
|
||
|
|
<dt class="dlterm">Authentication string</dt>
|
||
|
|
<dd>INPUT; CHAR(*) The string (such as a password) supplied by the client
|
||
|
|
program.<p>For the FTP server, this parameter contains the data field from
|
||
|
|
the PASS (password) subcommand (unless the user is authenticated by a client
|
||
|
|
certificate, in which case the client certificate is provided for this parameter).</p>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">Length of authentication string</dt>
|
||
|
|
<dd>INPUT; BINARY(4) The length (in bytes) of the authentication string.</dd>
|
||
|
|
<dt class="dlterm">CCSID of authentication string</dt>
|
||
|
|
<dd>INPUT; BINARY(4) The CCSID of the authentication string parameter. For
|
||
|
|
the FTP server: When the user is authenticated by a client certificate, this
|
||
|
|
parameter is set to -2.</dd>
|
||
|
|
<dt class="dlterm">Client IP address</dt>
|
||
|
|
<dd>INPUT; CHAR(*) The Internet Protocol (IP) address from which the session
|
||
|
|
originates. This string is in dotted decimal format, left justified.</dd>
|
||
|
|
<dt class="dlterm">Length of client IP address</dt>
|
||
|
|
<dd>INPUT; BINARY(4) Indicates the length (in bytes) of the client IP address.</dd>
|
||
|
|
<dt class="dlterm">Allow logon</dt>
|
||
|
|
<dd>OUTPUT; BINARY(4) Indicates whether the logon operation should be accepted
|
||
|
|
or rejected, and how password authentication is performed. The valid values
|
||
|
|
are:<dl><dt class="dlterm">0</dt>
|
||
|
|
<dd>Reject the logon operation. Ignores all other output parameters.</dd>
|
||
|
|
<dt class="dlterm">1</dt>
|
||
|
|
<dd>Continue the logon operation with the specified user identifier and authentication
|
||
|
|
string. The user identifier is the user profile, and the authentication string
|
||
|
|
is the password. The current library and working directory is based on the
|
||
|
|
settings of those output parameters. The application ignores the user profile
|
||
|
|
and password output parameters.<div class="note"><span class="notetitle">Note:</span> For the logon to succeed, the authentication
|
||
|
|
string must match the user profile-specified password.</div>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">2</dt>
|
||
|
|
<dd>Continue the logon operation. Override the user profile and password with
|
||
|
|
the returned values in the output parameters of this exit program. The application
|
||
|
|
initializes the current library and working directory based on the settings
|
||
|
|
of those output parameters.<div class="note"><span class="notetitle">Note:</span> For the logon to succeed, the password output
|
||
|
|
parameter must match the user profile-specified password. <p><strong><em>Attention!</em></strong> IBM<sup>®</sup> strongly
|
||
|
|
recommends that you <span class="uicontrol">never</span> code passwords directly in
|
||
|
|
an exit program. Encryption, for example, allows algorithmic password determination.</p>
|
||
|
|
</div>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">3</dt>
|
||
|
|
<dd>Accept the logon operation. Override the user profile with the profile
|
||
|
|
returned in the user profile output parameter of this exit program. The program
|
||
|
|
initializes the current library and working directory based on the settings
|
||
|
|
of the output parameters. It ignores the password output parameter.<div class="note"><span class="notetitle">Note:</span> If
|
||
|
|
the system is running at a security level of 20 or higher, specifying this
|
||
|
|
value overrides normal i5/OS™ password processing. This is the only password
|
||
|
|
authentication.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">User profile</dt>
|
||
|
|
<dd>OUTPUT; CHAR(10) The user profile to use for this session. When required,
|
||
|
|
this parameter must be left-aligned and padded with blanks.</dd>
|
||
|
|
<dt class="dlterm">Password</dt>
|
||
|
|
<dd>OUTPUT; CHAR(*) The password to use for this session. When required, the
|
||
|
|
Length of password and CCSID of password parameters must also be specified,
|
||
|
|
and this parameter must be left-justified. When the QPWDLVL system value is
|
||
|
|
set to 0 or 1, up to 10 characters can be specified; when the QPWDLVL system
|
||
|
|
value is set to 2 or 3, up to 128 characters can be specified.</dd>
|
||
|
|
<dt class="dlterm">Length of password</dt>
|
||
|
|
<dd>OUTPUT; BINARY(4) The length (in bytes) of the password. When required,
|
||
|
|
the valid range is 1 to 512 bytes.</dd>
|
||
|
|
<dt class="dlterm">CCSID of password</dt>
|
||
|
|
<dd>OUTPUT; BINARY(4) The CCSID of the password. This parameter must be set
|
||
|
|
by the exit program when the password parameter is specified. The valid values
|
||
|
|
are:<dl><dt class="dlterm">0</dt>
|
||
|
|
<dd>The CCSID of the job is used to determine the CCSID of the data to be
|
||
|
|
converted. If the job CCSID is 65535, the CCSID from the default CCSID (DFTCCSID)
|
||
|
|
job attribute is used.</dd>
|
||
|
|
<dt class="dlterm">1-65533</dt>
|
||
|
|
<dd>A valid CCSID in this range.</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">Initial current library</dt>
|
||
|
|
<dd>OUTPUT; CHAR(10) The initial current library to use for this session.
|
||
|
|
When required, this parameter must be left-aligned and padded with blanks.
|
||
|
|
This parameter is set to the following special value when the exit program
|
||
|
|
is called:*CURLIB- Use the current library that the user profile specifies.</dd>
|
||
|
|
<dt class="dlterm">Initial home directory</dt>
|
||
|
|
<dd>OUTPUT; CHAR(*) The initial setting of the home directory to use for this
|
||
|
|
session. When specified, this parameter must be a valid absolute path name,
|
||
|
|
and the length of initial home directory and CCSID of initial home directory
|
||
|
|
parameters set to the proper values.</dd>
|
||
|
|
<dt class="dlterm">Length of initial home directory</dt>
|
||
|
|
<dd>INPUT/OUTPUT; BINARY(4) The length of the initial home directory parameter
|
||
|
|
returned by the exit program. This parameter initializes at zero when the
|
||
|
|
application calls the exit program. If the exit program does not change the
|
||
|
|
value of the parameter, the home directory is initialized to the home directory
|
||
|
|
that the user's profile specifies.</dd>
|
||
|
|
<dt class="dlterm">CCSID of initial home directory</dt>
|
||
|
|
<dd>OUTPUT; BINARY(4) The CCSID of the initial home directory. This parameter
|
||
|
|
must be set by the exit program when the initial home directory is specified.
|
||
|
|
The valid values are:<dl><dt class="dlterm">0</dt>
|
||
|
|
<dd>The CCSID of the job is used to determine the CCSID of the data to be
|
||
|
|
converted. If the job CCSID is 65535, the CCSID from the default CCSID (DFTCCSID)
|
||
|
|
job attribute is used.</dd>
|
||
|
|
<dt class="dlterm">1-65533</dt>
|
||
|
|
<dd>A valid CCSID in this range.</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">Application-specific information</dt>
|
||
|
|
<dd>INPUT/OUTPUT; CHAR(*) Information that is used to communicate application-specific
|
||
|
|
logon settings. For the correct format, see <a href="rzaiqfaps.htm#rzaiqfaps">Format of application-specific information parameter</a>.</dd>
|
||
|
|
<dt class="dlterm">Length of application-specific information</dt>
|
||
|
|
<dd>INPUT; BINARY(4) The length (in bytes) of the application-specific information.</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiqlepi.htm" title="You can control the authentication of users to a TCP/IP application server with the TCP/IP Application Server Logon exit point.">Server logon exit point</a></div>
|
||
|
|
</div>
|
||
|
|
<div class="reltasks"><strong>Related tasks</strong><br />
|
||
|
|
<div><a href="rzaiqftpwbi.htm" title="You can configure an File Transfer Protocol (FTP) server on the iSeries to support graphical FTP clients, Web browsers, and other Web tools.">Configure FTP servers for graphical FTP clients and Web tools</a></div>
|
||
|
|
</div>
|
||
|
|
<div class="relref"><strong>Related reference</strong><br />
|
||
|
|
<div><a href="rzaiql0100.htm">TCPL0100 exit point format</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|