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

290 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="VLRQ0100 exit point format" />
<meta name="DC.Relation" scheme="URI" content="rzaiqsvreqep.htm" />
<meta name="DC.Relation" scheme="URI" content="rzaiqvlrq.htm" />
<meta name="DC.Relation" scheme="URI" content="rzaiqftpscon.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="rzaiqpsvrep" />
<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>VLRQ0100 exit point format</title>
</head>
<body id="rzaiqpsvrep"><a name="rzaiqpsvrep"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">VLRQ0100 exit point format</h1>
<div><div class="section"><p>The exit point for FTP Server Application Request Validation is:</p>
<p>QIBM_QTMF_SERVER_REQ</p>
<p>The
exit point for FTP Client Application Request Validation is:</p>
<p>QIBM_QTMF_CLIENT_REQ</p>
<p>The
interface that controls the parameter format for the exit point is:</p>
<p>VLRQ0100</p>
<p>The
following table shows the parameters and parameter format for the VLRQ0100
interface.</p>
</div>
<div class="section"><h4 class="sectiontitle">Required parameter format for the VLRQ0100 exit point interface</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e39">Parameter</th>
<th valign="top" id="d0e41">Description</th>
<th valign="top" id="d0e43">Input or output</th>
<th valign="top" id="d0e45">Type and length</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e39 ">1</td>
<td valign="top" headers="d0e41 ">Application identifier</td>
<td valign="top" headers="d0e43 ">Input</td>
<td valign="top" headers="d0e45 ">Binary (4)</td>
</tr>
<tr><td valign="top" headers="d0e39 ">2</td>
<td valign="top" headers="d0e41 ">Operation identifier</td>
<td valign="top" headers="d0e43 ">Input</td>
<td valign="top" headers="d0e45 ">Binary (4)</td>
</tr>
<tr><td valign="top" headers="d0e39 ">3</td>
<td valign="top" headers="d0e41 ">User profile</td>
<td valign="top" headers="d0e43 ">Input</td>
<td valign="top" headers="d0e45 ">Char (10)</td>
</tr>
<tr><td valign="top" headers="d0e39 ">4</td>
<td valign="top" headers="d0e41 ">Remote IP address</td>
<td valign="top" headers="d0e43 ">Input</td>
<td valign="top" headers="d0e45 ">Char (*)</td>
</tr>
<tr><td valign="top" headers="d0e39 ">5</td>
<td valign="top" headers="d0e41 ">Length of remote IP address</td>
<td valign="top" headers="d0e43 ">Input</td>
<td valign="top" headers="d0e45 ">Binary (4)</td>
</tr>
<tr><td valign="top" headers="d0e39 ">6</td>
<td valign="top" headers="d0e41 ">Operation-specific information</td>
<td valign="top" headers="d0e43 ">Input</td>
<td valign="top" headers="d0e45 ">Char (*)</td>
</tr>
<tr><td valign="top" headers="d0e39 ">7</td>
<td valign="top" headers="d0e41 ">Length of operation-specific information</td>
<td valign="top" headers="d0e43 ">Input</td>
<td valign="top" headers="d0e45 ">Binary (4)</td>
</tr>
<tr><td valign="top" headers="d0e39 ">8</td>
<td valign="top" headers="d0e41 ">Allow operation</td>
<td valign="top" headers="d0e43 ">Output</td>
<td valign="top" headers="d0e45 ">Binary (4)</td>
</tr>
</tbody>
</table>
</div>
<p>Here are the parameter descriptions:</p>
<dl><dt class="dlterm">VLRQ0100 Parameter 1:</dt>
<dd>Application identifier</dd>
<dt class="dlterm">INPUT; BINARY(4)</dt>
<dd>Identifies the TCP/IP application program that is making the request.
Four different TCP/IP applications share the VLRQ0100 interface. The first
parameter identifies which application is calling the exit program. The following
table demonstrates the possible values.</dd>
</dl>
<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="d0e139">Value</th>
<th valign="bottom" id="d0e141">Application</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e139 ">0</td>
<td valign="top" headers="d0e141 ">FTP client program</td>
</tr>
<tr><td valign="top" headers="d0e139 ">1</td>
<td valign="top" headers="d0e141 ">FTP server program</td>
</tr>
<tr><td valign="top" headers="d0e139 ">2</td>
<td valign="top" headers="d0e141 ">REXEC server program</td>
</tr>
<tr><td valign="top" headers="d0e139 ">3</td>
<td valign="top" headers="d0e141 ">TFTP server program</td>
</tr>
</tbody>
</table>
</div>
<dl><dt class="dlterm">VLRQ0100 Parameter 2:</dt>
<dd>Operation identifier</dd>
<dt class="dlterm">Input; Binary(4)</dt>
<dd>Indicates the operation (command) that the FTP user wants (requests) to
perform.</dd>
</dl>
<p>The following table demonstrates the possible values when
the application identifier (parameter 1) indicates the FTP client or FTP server
program.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e185">Value</th>
<th valign="top" id="d0e187">Operation ID</th>
<th valign="top" id="d0e189">Client subcommand</th>
<th valign="top" id="d0e191">Server subcommand</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e185 ">0</td>
<td valign="top" headers="d0e187 ">Start session</td>
<td valign="top" headers="d0e189 ">Open, SECOpen</td>
<td valign="top" headers="d0e191 ">New connection</td>
</tr>
<tr><td valign="top" headers="d0e185 ">1</td>
<td valign="top" headers="d0e187 ">Create directory/library</td>
<td valign="top" headers="d0e189 ">*</td>
<td valign="top" headers="d0e191 ">MKD, XMDK</td>
</tr>
<tr><td valign="top" headers="d0e185 ">2</td>
<td valign="top" headers="d0e187 ">Delete directory/library</td>
<td valign="top" headers="d0e189 ">*</td>
<td valign="top" headers="d0e191 ">RMD, XRMD</td>
</tr>
<tr><td valign="top" headers="d0e185 ">3</td>
<td valign="top" headers="d0e187 ">Set current directory/library</td>
<td valign="top" headers="d0e189 ">LCD</td>
<td valign="top" headers="d0e191 ">CWD, CDUP, XCWD, XCUP</td>
</tr>
<tr><td valign="top" headers="d0e185 ">4</td>
<td valign="top" headers="d0e187 ">List files</td>
<td valign="top" headers="d0e189 ">*</td>
<td valign="top" headers="d0e191 ">LIST, NLIST</td>
</tr>
<tr><td valign="top" headers="d0e185 ">5</td>
<td valign="top" headers="d0e187 ">Delete file</td>
<td valign="top" headers="d0e189 ">*</td>
<td valign="top" headers="d0e191 ">DELE</td>
</tr>
<tr><td valign="top" headers="d0e185 ">6</td>
<td valign="top" headers="d0e187 ">Send file</td>
<td valign="top" headers="d0e189 ">APPEND, PUT, MPUT</td>
<td valign="top" headers="d0e191 ">RETR</td>
</tr>
<tr><td valign="top" headers="d0e185 ">7</td>
<td valign="top" headers="d0e187 ">Receive file</td>
<td valign="top" headers="d0e189 ">GET, MGET</td>
<td valign="top" headers="d0e191 ">APPE, STOR, STOU</td>
</tr>
<tr><td valign="top" headers="d0e185 ">8</td>
<td valign="top" headers="d0e187 ">Rename file</td>
<td valign="top" headers="d0e189 ">*</td>
<td valign="top" headers="d0e191 ">RNFR, RNTO</td>
</tr>
<tr><td valign="top" headers="d0e185 ">9</td>
<td valign="top" headers="d0e187 ">Execute CL command</td>
<td valign="top" headers="d0e189 ">SYSCMD</td>
<td valign="top" headers="d0e191 ">RCMD, ADDm, ADDV, CRTL, CRTP, CRTS, DLTF, DLTL </td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> The asterisk symbol (*) represents control operations
that the FTP client exit does not recognize. The only way a client can use
these operations is with CL commands using the FTP client subcommand SYSCMD.
Operation identifier 9 controls the execution of CL commands.</div>
<dl><dt class="dlterm">VLRQ0100 Parameter 3:</dt>
<dd>User profile</dd>
<dt class="dlterm">INPUT; Char(10)</dt>
<dd>The user profile for the FTP session.</dd>
<dt class="dlterm">VLRQ0100 Parameter 4:</dt>
<dd> Remote IP address</dd>
<dt class="dlterm">INPUT; CHAR(*)</dt>
<dd>The Internet Protocol (IP) address of the remote host system. The format
for this string is dotted decimal (123.45.67.89), left-aligned. The remote
host can be a client or a server that is based on the setting of the application
identifier parameter.</dd>
<dt class="dlterm">VLRQ0100 Parameter 5:</dt>
<dd>Length (in bytes) of the remote IP address (parameter 4)</dd>
<dt class="dlterm">INPUT; BINARY(4)</dt>
<dd>The length of the remote IP address (parameter 4).</dd>
<dt class="dlterm">VLRQ0100 Parameter 6:</dt>
<dd>Operation-specific information</dd>
<dt class="dlterm">INPUT; CHAR(*)</dt>
<dd> Information that describes the requested operation. The contents of this
field depend on the values of the operation identifier (parameter 2), and
the application identifier (parameter 1). For example:<dl><dt class="dlterm">For operation identifier 0 and application identifier 0</dt>
<dd>There is no operation-specific information. This field is blank.</dd>
<dt class="dlterm">For operation identifier 0 and application identifier 1</dt>
<dd>The operation-specific information contains the IP address of the TCP/IP
interface that connects to the local host (FTP server) for this session. The
format for this string is dotted decimal (123.45.67.89), left-aligned.</dd>
<dt class="dlterm">For operation identifiers 1 through 3</dt>
<dd>The operation-specific information contains the name of the directory
or library in which to perform the operation. The format for the directory
or library name is an absolute path name.</dd>
<dt class="dlterm">For operation identifiers 4 through 8</dt>
<dd>The operation-specific information contains the name of the file on which
to perform the operation. The format for the file name is an absolute path
name.</dd>
<dt class="dlterm">For operation identifier 9</dt>
<dd>The operation-specific information contains the iSeries™ Control Language (CL) command
the user requests.</dd>
</dl>
</dd>
</dl>
<dl><dt class="dlterm">VLRQ0100 Parameter 7:</dt>
<dd>Length of operation-specific information.</dd>
<dt class="dlterm">INPUT; BINARY(4)</dt>
<dd>Indicates the length of the operation-specific information (parameter
6). Length is 0 when the exit point does not provide operation-specific information.</dd>
<dt class="dlterm">VLRQ0100 Parameter 8:</dt>
<dd> Allow operation.</dd>
<dt class="dlterm">OUTPUT; BINARY(4)</dt>
<dd>Indicates whether to allow or reject the requested operation. The following
table demonstrates the possible values.</dd>
</dl>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr valign="bottom"><th valign="bottom" class="firstcol" id="d0e383">Value</th>
<th valign="bottom" id="d0e385">Description</th>
</tr>
</thead>
<tbody><tr><th valign="top" class="firstcol" id="d0e389" headers="d0e383 ">-1</th>
<td valign="top" headers="d0e389 d0e385 "><em>Never</em> allow this operation identifier: <p>Reject
this operation identifier unconditionally for the remainder of the current
session.</p>
<p>This operation identifier will not call the exit program again.</p>
</td>
</tr>
<tr><th valign="top" class="firstcol" id="d0e400" headers="d0e383 ">0</th>
<td valign="top" headers="d0e400 d0e385 ">Reject the operation</td>
</tr>
<tr><th valign="top" class="firstcol" id="d0e405" headers="d0e383 ">1</th>
<td valign="top" headers="d0e405 d0e385 ">Allow the operation</td>
</tr>
<tr><th valign="top" class="firstcol" id="d0e410" headers="d0e383 ">2</th>
<td valign="top" headers="d0e410 d0e385 "><em>Always</em> allow this operation identifier: <p>Allow
this operation identifier unconditionally for the remainder of the current
session.</p>
<p>This operation identifier will not call the exit program again.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="rzaiqvlrq.htm">VLRQ0100 exit point format usage notes</a></strong><br />
VLRQ0100 is the exit point format that is used for both the File Transfer Protocol (FTP) Client Request Validation Exit Point and the FTP Server Request Validation Exit Point.</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiqsvreqep.htm" title="The Request Validation exit points can be used to restrict operations which can be performed by FTP users. Request validation exit points are provided by both the FTP client and server; to restrict both FTP client and FTP server access, exit programs must be added to both exit points.">Request validation exit point: Client and server</a></div>
</div>
<div class="relconcepts"><strong>Related concepts</strong><br />
<div><a href="rzaiqftpscon.htm" title="You can use File Transfer Protocol (FTP) exit points to protect the iSeries from this topic.">Manage access using File Transfer Protocol exit programs</a></div>
</div>
</div>
</body>
</html>