ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaiq_5.4.0.1/rzaiql0100.htm

220 lines
11 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="TCPL0100 exit point format" />
<meta name="DC.Relation" scheme="URI" content="rzaiqlepi.htm" />
<meta name="DC.Relation" scheme="URI" content="rzaiqusnts.htm" />
<meta name="DC.Relation" scheme="URI" content="rzaiql0200.htm" />
<meta name="DC.Relation" scheme="URI" content="rzaiql0300.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="rzaiql0100" />
<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>TCPL0100 exit point format</title>
</head>
<body id="rzaiql0100"><a name="rzaiql0100"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">TCPL0100 exit point format</h1>
<div><div class="section"><p>Exit Point Format Name: TCPL0100<br />
Exit Point Name: QIBM_QTMF_SVR_LOGON<br />
Exit Point Name: QIBM_QTMX_SVR_LOGON</p>
<div class="p">This is the required parameter
group.
<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="d0e26">Parameter</th>
<th valign="bottom" id="d0e28">Description</th>
<th valign="bottom" id="d0e30">Input or output</th>
<th valign="bottom" id="d0e32">Type and length</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e26 ">1</td>
<td valign="top" headers="d0e28 ">Application identifier</td>
<td valign="top" headers="d0e30 ">Input</td>
<td valign="top" headers="d0e32 ">Binary(4)</td>
</tr>
<tr><td valign="top" headers="d0e26 ">2</td>
<td valign="top" headers="d0e28 ">User identifier</td>
<td valign="top" headers="d0e30 ">Input</td>
<td valign="top" headers="d0e32 ">Char(*)</td>
</tr>
<tr><td valign="top" headers="d0e26 ">3</td>
<td valign="top" headers="d0e28 ">Length of user identifier</td>
<td valign="top" headers="d0e30 ">Input</td>
<td valign="top" headers="d0e32 ">Binary(4)</td>
</tr>
<tr><td valign="top" headers="d0e26 ">4</td>
<td valign="top" headers="d0e28 ">Authentication string</td>
<td valign="top" headers="d0e30 ">Input</td>
<td valign="top" headers="d0e32 ">Char(*)</td>
</tr>
<tr><td valign="top" headers="d0e26 ">5</td>
<td valign="top" headers="d0e28 ">Length of authentication string</td>
<td valign="top" headers="d0e30 ">Input</td>
<td valign="top" headers="d0e32 ">Binary(4)</td>
</tr>
<tr><td valign="top" headers="d0e26 ">6</td>
<td valign="top" headers="d0e28 ">Client IP address</td>
<td valign="top" headers="d0e30 ">Input</td>
<td valign="top" headers="d0e32 ">Char(*)</td>
</tr>
<tr><td valign="top" headers="d0e26 ">7</td>
<td valign="top" headers="d0e28 ">Length of client IP address</td>
<td valign="top" headers="d0e30 ">Input</td>
<td valign="top" headers="d0e32 ">Binary(4)</td>
</tr>
<tr><td valign="top" headers="d0e26 ">8</td>
<td valign="top" headers="d0e28 ">Return code</td>
<td valign="top" headers="d0e30 ">Output</td>
<td valign="top" headers="d0e32 ">Binary(4)</td>
</tr>
<tr><td valign="top" headers="d0e26 ">9</td>
<td valign="top" headers="d0e28 ">User profile</td>
<td valign="top" headers="d0e30 ">Output</td>
<td valign="top" headers="d0e32 ">Char(10)</td>
</tr>
<tr><td valign="top" headers="d0e26 ">10</td>
<td valign="top" headers="d0e28 ">Password</td>
<td valign="top" headers="d0e30 ">Output</td>
<td valign="top" headers="d0e32 ">Char(10)</td>
</tr>
<tr><td valign="top" headers="d0e26 ">11</td>
<td valign="top" headers="d0e28 ">Initial current library</td>
<td valign="top" headers="d0e30 ">Output</td>
<td valign="top" headers="d0e32 ">Char(10)</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Parameter descriptions</h4><dl><dt class="dlterm">Application identifier</dt>
<dd>INPUT; BINARY(4) Identifies the requested application server. 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.
For the FTP server, this parameter contains the data field from the USER subcommand.</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. Beginning with V5R1, if the user is authenticated
by a client certificate, no data 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.<div class="note"><span class="notetitle">Note:</span> For
the FTP server: When the user is authenticated by a client certificate, this
parameter is set to 0.</div>
</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">Return code</dt>
<dd>OUTPUT; BINARY(4) Indicates whether to accept or reject the logon operation,
to perform password authentication, and whether or not to override the initial
current library. The valid values are:<dl><dt class="dlterm">0</dt>
<dd> Reject the logon operation. Ignore the user profile, password, and initial
current library output parameters.</dd>
<dt class="dlterm">1</dt>
<dd>Continue the logon operation with the specified user identifier and authentication
string, and the user-specified the initial current library. The user identifier
becomes the user profile, and the authentication string becomes the password.
The program ignores the user profile, password, and initial current library
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 with the specified user identifier and authentication
string, and override the initial current library with the one specified by
the initial current library parameter. The user identifier is the user profile.
The authentication string is the password. Provide the initial current library
output parameter. The program 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">3</dt>
<dd>Continue the logon operation. Override the user profile and password with
those values you received from the output parameters of this exit program.
Use the user profile-specified initial current library that the exit program
returns. The program ignores the initial current library output parameter.<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">4</dt>
<dd>Continue the logon operation, which will override the user profile, password,
and initial current library with output parameters of this exit program.<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 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">5</dt>
<dd> Accept the logon operation. Override the user profile is returned in
the user profile output parameter of this exit program. Use the initial current
library specified by the user profile, returned by this exit program. The
program ignores the output parameters for the initial current library and
password.<div class="note"><span class="notetitle">Note:</span> Specifying this value overrides
normal i5/OS™ password
processing. It is the only password authentication.</div>
</dd>
<dt class="dlterm">6</dt>
<dd>Accept the logon operation. Override the user profile and initial current
library with those that are returned in the output parameters of this exit
program. Ignore the output parameter for password.<div class="note"><span class="notetitle">Note:</span> Specifying
this value overrides normal i5/OS password processing. It 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. This parameter
must be left justified and padded with blanks.</dd>
<dt class="dlterm">Password</dt>
<dd> OUTPUT; CHAR(10) The password to use for this session. This parameter
must be left justified and padded with blanks.</dd>
<dt class="dlterm">Initial current library</dt>
<dd>OUTPUT; CHAR(10) The initial current library to be established for this
session. This parameter must be left justified and padded with blanks.</dd>
</dl>
</div>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="rzaiqusnts.htm">TCPL0100 format usage notes</a></strong><br />
</li>
</ul>
<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="relref"><strong>Related reference</strong><br />
<div><a href="rzaiql0200.htm">TCPL0200 exit point format</a></div>
<div><a href="rzaiql0300.htm">TCPL0300 exit point format</a></div>
</div>
</div>
</body>
</html>