friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8826eae394
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qfpchgae.htm

737 lines
20 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Change NetWare Authentication Entry (QfpzChgNtwAutE) API</title>
<!-- Begin Header Records ========================================== -->
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
<!-- 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. -->
<!-- Sec SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- Edited by Kersten Jan 02 -->
<!-- This file has undergone html cleanup July 2002 by JET -->
<!--End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Change NetWare Authentication Entry (QfpzChgNtwAutE) API</h2>
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Entry identifier data</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Length of entry identifier</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Entry identifier format name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Authentication entry data</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Length of authentication entry</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Entry data format name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Library Name/Service Program: QFPNTWE/QFPZAAPI<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Change NetWare Authentication Entry (QfpzChgNtwAutE) API changes the
authentication information in the specified authentication entry. The format
that is specified for the authentication entry must correspond to the server
type of the existing entry.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>User Profile Authority</em></dt>
<dd>The user profile must be the current user profile, or the caller must have
*USE and *OBJMGT authority to the user profile and *SECADM special
authority.</dd>
</dl>
<br>
<h3><a name="HDRCSAERPG">Required Parameter Group</a></h3>
<dl>
<dt><strong>Entry identifier data</strong></dt>
<dd>INPUT; CHAR(*)
<p>The authentication entry to be changed. The content and format of this
structure are determined by the format name. See <a href="#HDRCSAIFMT">Format
of Authentication Entry Identifier</a> for a description of these formats.</p>
</dd>
<dt><strong>Length of entry identifier</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the entry identifier data structure.</p>
</dd>
<dt><strong>Entry identifier format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The content and format of the authentication entry identifier data.</p>
<p>The possible format names follow:</p>
<table cellpadding="5">
<!-- cols="30 70" -->
<tr>
<td align="left" valign="top"><em><a href="#aute0100">AUTE0100</a></em></td>
<td align="left" valign="top">NetWare Version 3.x server authentication entry
identifier</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#aute0200">AUTE0200</a></em></td>
<td align="left" valign="top">NetWare Directory Services tree authentication
entry identifier</td>
</tr>
</table>
<br>
<p>See <a href="#HDRCSAIFMT">Format of Authentication Entry Identifier</a> for
a description of these formats.</p>
</dd>
<dt><strong>Authentication entry data</strong></dt>
<dd>INPUT; CHAR(*)
<p>The changed authentication entry data. The content and format of this
structure are determined by the format name. See <a href="#HDRCSAEFMT">Format
of Authentication Entry Data</a> for a description of these formats.</p>
</dd>
<dt><strong>Length of authentication entry</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the authentication entry data structure.</p>
</dd>
<dt><strong>Entry data format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The content and format of the authentication entry input data. Each format
corresponds to a type of authentication entry.</p>
<p>The possible format names follow:</p>
<table cellpadding="5">
<!-- cols="30 70" -->
<tr>
<td align="left" valign="top"><a href="#HDRCSAE2"><em>AUTD0100</em></a></td>
<td align="left" valign="top">NetWare Version 3.x server authentication entry
data</td>
</tr>
<tr>
<td align="left" valign="top"><em><a href="#HDRCSAE3">AUTD0200</a></em></td>
<td align="left" valign="top">NetWare Directory Services tree authentication
entry data</td>
</tr>
</table>
<br>
<p>See <a href="#HDRCSAEFMT">Format of Authentication Entry Data</a> for a
description of these formats.</p>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>. </p>
</dd>
</dl>
<br>
<h3><a name="HDRCSAIFMT">Format of Authentication Entry Identifier</a></h3>
<p>For details about the format of the entry identifier data, see the following
sections. For details about the fields in each format, see <a href=
"#HDRCSAEFLD">Field Descriptions</a>.</p>
<h3><a name="aute0100">AUTE0100 Format</a></h3>
<p>This format is used to identify a NetWare Version 3.x server authentication
entry.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Offset to server name</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of server name</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User profile name</td>
</tr>
<tr>
<td align="center" valign="top">18</td>
<td align="center" valign="top">12</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Server name</td>
</tr>
</table>
<br>
<br>
<h3><a name="aute0200">AUTE0200 Format</a></h3>
<p>This format is used to identify a NetWare Directory Services tree
authentication entry.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Offset to NDS tree name</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of NDS tree name</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User profile name</td>
</tr>
<tr>
<td align="center" valign="top">18</td>
<td align="center" valign="top">12</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">NDS tree name</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCSAEFMT">Format of Authentication Entry Data</a></h3>
<p>For details about the format of the authentication entries, see the
following sections. For details about the fields in each format, see <a href=
"#HDRCSAEFLD">Field Descriptions</a>.</p>
<h3><a name="HDRCSAE2">AUTD0100 Format</a></h3>
<p>This format is used to specify the authentication entry data for a NetWare
Version 3.x server authentication entry. This format must be used when entry
identifier format AUTE0100 is used.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Offset to NetWare user name</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of NetWare user name</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to password</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of password</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">NetWare user name</td>
</tr>
<tr>
<td align="center" valign="top"></td>
<td align="center" valign="top"></td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Password</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCSAE3">AUTD0200 Format</a></h3>
<p>This format is used to specify the authentication entry data for a NetWare
Directory Services tree authentication entry. This format must be used when
entry identifier format AUTE0200 is used.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Offset to NDS context</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of NDS context</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to NetWare user name</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of NetWare user name</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to password</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of password</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">NDS context</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">NetWare user name</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Password</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCSAEFLD">Field Descriptions</a></h3>
<p><strong>Length of NDS context.</strong> The length, in bytes, of the NDS
context.</p>
<p><strong>Length of NDS tree name.</strong> The length, in bytes, of the NDS
tree name.</p>
<p><strong>Length of NetWare user name.</strong> The length, in bytes, of the
NetWare user name.</p>
<p><strong>Length of password.</strong> The length, in bytes, of the
password.</p>
<p><strong>Length of server name.</strong> The length, in bytes, of the server
name.</p>
<p><strong>NDS context.</strong> For NDS trees, the directory context in which
the user is defined.</p>
<p>The following special value may be used:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The value remains the same.</td>
</tr>
</table>
<p><strong>NDS tree name.</strong> For NDS trees, the name of the directory
tree to which the authentication entry applies.</p>
<p>The selected NDS tree name must be the same as the NDS tree name of an
existing NetWare Directory Services tree authentication entry.</p>
<p><strong>NetWare user name.</strong> The NetWare user name that is used to
authenticate the user to the server.</p>
<p>The following special values may be used:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*USRPRF</em></td>
<td align="left" valign="top">The NetWare user name is the same as the user
profile name.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The value remains the same.</td>
</tr>
</table>
<p><strong>Offset to NDS context.</strong> The offset, in bytes, from the start
of the input data area to the NDS context.</p>
<p><strong>Offset to NDS tree name.</strong> The offset, in bytes, from the
start of the input data area to the NDS tree name.</p>
<p><strong>Offset to NetWare user name.</strong> The offset, in bytes, from the
start of the input data area to the NetWare user name</p>
<p><strong>Offset to password.</strong> The offset, in bytes, from the start of
the input data area to the password.</p>
<p><strong>Offset to server name.</strong> The offset, in bytes, from the start
of the input data area to the server name.</p>
<p><strong>Password.</strong> The password that is used to authenticate the
user to the server.</p>
<p>The following special values may be used:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">The system does not need password information to
authenticate the user.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*STRNTWCNN</em></td>
<td align="left" valign="top">The system does not store the password
information in the authentication entry. Use Start NetWare Connection
(STRNTWCNN) command, with the correct password, to start a connection to a
server.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SAME</em></td>
<td align="left" valign="top">The value remains the same.</td>
</tr>
</table>
<p><strong>Reserved.</strong> Set this field to binary zeros.</p>
<p><strong>Server name.</strong> The name of the server to which the
authentication entry applies.</p>
<p>The selected server name must be the same as the server name of an existing
NetWare Version 3.x server authentication entry.</p>
<p><strong>User profile name.</strong> The name of the user profile that
contains the authentication entry.</p>
<p>You can use the following special value for the user profile name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURRENT</em></td>
<td align="left" valign="top">Use the current user profile.</td>
</tr>
</table>
<br>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPF2204 E</td>
<td width="85%" valign="top">User profile &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2217 E</td>
<td align="left" valign="top">Not authorized to user profile &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td align="left" valign="top">Severe error while addressing parameter
list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C1D E</td>
<td align="left" valign="top">Length specified in parameter &amp;1 not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">FPE0211 E</td>
<td align="left" valign="top">Parameter length &amp;1 not valid for field
&amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">FPE0212 E</td>
<td align="left" valign="top">Field offset and length not within data.</td>
</tr>
<tr>
<td align="left" valign="top">FPE0215 E</td>
<td align="left" valign="top">Could not find authentication entry for
&amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">FPE021F E</td>
<td align="left" valign="top">Data format &amp;1 not valid with identifier
format &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">FPE0255 E</td>
<td align="left" valign="top">PASSWORD(*STRNTWCNN) required when QRETSVRSEC is
0.</td>
</tr>
</table>
<br>
<hr>
API introduced: V3R7
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"sec.htm">Security APIs</a> | <a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink