1792 lines
50 KiB
HTML
1792 lines
50 KiB
HTML
<!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>Open List Network Server Users (QFPADOLU) API</title>
|
|
<!-- Begin Header Records ========================================== -->
|
|
<!-- 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. -->
|
|
<!-- QFPADOLU SCRIPT A converted by B2H R4.1 (346) (CMS) by V2DCIJB -->
|
|
<!-- at RCHVMW2 on 20 Aug 1999 at 12:37:54 -->
|
|
<!-- ==========CHANGE HISTORY======================================= -->
|
|
<!-- DCR/PTR Rel Date Person : Description of change -->
|
|
<!-- D12196.1 5D10 102700 KRYKA : Server rebranding -->
|
|
<!-- D12196.1 5D10 110600 KRYKA : Authority & Intro -->
|
|
<!-- D12406 5D20 101601 KRYKA : Format fixes -->
|
|
<!-- D12406 5D20 102501 KRYKA : 282 rebranding -->
|
|
<!-- D99492 5D30 082302 MEADEN : Add Win Name, Perf improvements -->
|
|
<!-- D99492 5D30 040803 ANNASORT: *GROUPBASIC to *GRPBASIC -->
|
|
<!-- P9A99521 5D40 060305 RBIERLE : Add note about Authorities -->
|
|
<!-- P9A99521 5D40 060314 NLKRYKA : *ALL for specific user format -->
|
|
<!--File cleanup completed Oct 2001 by Janet Brauckman -->
|
|
<!-- 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>Open List Network Server Users (QFPADOLU) API</h2>
|
|
|
|
<div class="box" style="width: 90%;">
|
|
<br>
|
|
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="55%">Receiver variable</td>
|
|
<td align="left" valign="top" width="20%">Output</td>
|
|
<td align="left" valign="top" width="15%">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Length of receiver variable</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">List information</td>
|
|
<td align="left" valign="top">Output</td>
|
|
<td align="left" valign="top">Char(80)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Number of records to return</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">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">6</td>
|
|
<td align="left" valign="top">Profile type</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</td>
|
|
<td align="left" valign="top">Profile name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">Windows domain name qualifier</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">9</td>
|
|
<td align="left" valign="top">Length of Windows domain name qualifier</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">Windows server name qualifier</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">11</td>
|
|
<td align="left" valign="top">Length of Windows server name qualifier</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</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>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Open List Network Server Users (QFPADOLU) API generates a list of
|
|
Windows domains and servers, and the associated profiles enrolled to them in
|
|
the network. The list will be returned grouped by domain or server name, and
|
|
within the domain or server, by profile name.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<dl>
|
|
<dt><em>Authority to User Profiles in List of Authorized Users</em></dt>
|
|
|
|
<dd>*READ</dd>
|
|
|
|
<dd><img src="delta.gif" alt="Start of change"><strong>Note: </strong>Only those profiles to which you have *READ authority
|
|
are returned in the list.<img src="deltaend.gif" alt="End of change"> </dd>
|
|
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Receiver variable</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>The receiver variable that receives the information requested. You can
|
|
specify the size of the area to be smaller than the format requested as long as
|
|
you specify the length parameter correctly. As a result, the API returns only
|
|
the data the area can hold.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the receiver variable provided. The length of the receiver
|
|
variable parameter may be specified up to the size of the receiver variable
|
|
specified in the user program. If the length of the receiver variable parameter
|
|
specified is larger than the allocated size of the receiver variable specified
|
|
in the user program, the results are not predictable. The minimum length is 0
|
|
bytes.</p>
|
|
</dd>
|
|
|
|
<dt><strong>List information</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(80)
|
|
|
|
<p>Information about the list created by this program. For a description of the
|
|
layout of this parameter, see <a href="#HDRODOLUI">Format of List
|
|
Information</a>.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Number of records to return</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The number of records in the list to put into the receiver variable. The
|
|
value must be 0 or greater.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format of the information returned. You must use the following format
|
|
name:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="25 75" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em><a href="#HDRDOLU100">DOLU0100</a></em></td>
|
|
<td align="left" valign="top">Returns records for user and associated group
|
|
records, or records for group and associated user records.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em><a href="#HDRDOLU150">DOLU0150</a></em></td>
|
|
<td align="left" valign="top">Returns records for user and associated group
|
|
records, or records for group and associated user records.
|
|
The difference between this format and format
|
|
DOLU0100 is that this format includes the Windows user name in user records.
|
|
<p><strong>Note: </strong>
|
|
The Windows user name could be different than the enrolled i5/OS user name
|
|
if Enterprise Identity Mapping (EIM) is being used for the enrolled user.</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em><a href="#HDRDOLU200">DOLU0200</a></em></td>
|
|
<td align="left" valign="top">Returns a short version of
|
|
records for user and associated group records,
|
|
or records for group and associated user records.
|
|
<p><strong>Note: </strong>This format is faster than formats DOLU0100 and DOLU0150.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Profile type</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>Whether profile information returned is on a user profile or group profile
|
|
basis. Values can be:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*USER</em></td>
|
|
<td align="left" valign="top">Retrieve information about profiles defined as
|
|
users on the selected domains or servers. The group information for each group
|
|
of which the user is a member is also returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*GROUP</em></td>
|
|
<td align="left" valign="top">Retrieve information about profiles defined as
|
|
groups on the selected domains or servers. The users belonging to each group are
|
|
also returned.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*USERBASIC</em></td>
|
|
<td align="left" valign="top">Retrieve information about profiles defined as
|
|
users on the selected domains or servers. All user records are returned, without the
|
|
associated group records.
|
|
<p><strong>Note: </strong>This option is faster than the *USER option.
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*GRPBASIC</em></td>
|
|
<td align="left" valign="top">Retrieve information about profiles defined as groups
|
|
on the selected domains or servers. All group records are returned, without the
|
|
associated user records.
|
|
<p><strong>Note: </strong>This option is faster than the *GROUP option.
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">Retrieve both group and user information for a
|
|
single domain or server. All group records are returned first, without the
|
|
associated user records. Then all user records are returned, without the
|
|
associated group records.
|
|
<img src="delta.gif" alt="Start of change">
|
|
The records will be returned in the *USER format if a specific user profile
|
|
is requested.
|
|
<img src="deltaend.gif" alt="End of change">
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NONE</em></td>
|
|
<td align="left" valign="top">Retrieve information for domains and servers, but
|
|
not for users or groups. Records for domains are returned first, followed by
|
|
records for servers. No user or group records are returned.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Profile name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The names of the profiles to be included in the list. A specific profile can
|
|
be specified, or the profile name can be specified with a generic name (such as
|
|
'USER*') to retrieve a list of all profiles starting with the specified
|
|
letters. Allowable values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">Information about all profiles</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Profile name</em></td>
|
|
<td align="left" valign="top">Information about the specified profile name
|
|
record only.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Generic profile name*</em></td>
|
|
<td align="left" valign="top">Information about profiles matching the generic
|
|
profile name string.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Usage note:</strong> Avoid the use of characters '5B'X, '7B'X, and
|
|
'7C'X (CCSID 37 characters '$', '#', and '@', respectively) in profile
|
|
names.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Windows domain name qualifier</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The names of the Windows domains to be included in the list. A specific
|
|
domain can be specified, or the domain name can be specified with a generic
|
|
name (such as 'DMN*') to retrieve a list of all domains starting with the
|
|
specified letters. Allowable values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">All domains with which users are enrolled are to
|
|
be included in the list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NONE</em></td>
|
|
<td align="left" valign="top">No domains are to be included in the list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NWSA</em></td>
|
|
<td align="left" valign="top">Only the system default domains shown on the
|
|
Display Network Server Attributes (DSPNWSA) command are to be included in the
|
|
list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Domain name</em></td>
|
|
<td align="left" valign="top">Information about the specified domain only.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Generic domain name*</em></td>
|
|
<td align="left" valign="top">Information about domains matching the generic
|
|
domain name string.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Length of Windows domain name qualifier</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the Windows domain name qualifier.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Windows server name qualifier</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The names of the Windows servers to be included in the list. A specific
|
|
server can be specified, or the server name can be specified with a generic
|
|
name (such as 'SRV*') to retrieve a list of all servers starting with the
|
|
specified letters. Allowable values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*ALL</em></td>
|
|
<td align="left" valign="top">All servers with which users are enrolled are to
|
|
be included in the list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NONE</em></td>
|
|
<td align="left" valign="top">No servers are to be included in the list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NWSA</em></td>
|
|
<td align="left" valign="top">Only the system default servers shown on the
|
|
Display Network Server Attributes (DSPNWSA) command are to be included in the
|
|
list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Server name</em></td>
|
|
<td align="left" valign="top">Information about the specified server only.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Generic server name*</em></td>
|
|
<td align="left" valign="top">Information about servers matching the generic
|
|
server name string.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Length of Windows server name qualifier</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the Windows server name qualifier.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Error code</strong></dt>
|
|
|
|
<dd>I/O; CHAR(*)</dd>
|
|
</dl>
|
|
|
|
<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>. If this
|
|
parameter is omitted, diagnostic and escape messages are issued to the
|
|
application.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRDOLUF1">Format of Data Returned</a></h3>
|
|
|
|
<p>The list data returned for the DOLU0100, DOLU0150 and DOLU0200 formats contain three types of records:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>Server records</em></td>
|
|
<td align="left" valign="top">Contain information about a domain or
|
|
server.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>User records</em></td>
|
|
<td align="left" valign="top">Contain information about a user profile.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Group records</em></td>
|
|
<td align="left" valign="top">Contain information about a group profile.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>If the profile type requested is *USER, then records are returned as
|
|
follows:</p>
|
|
|
|
<ul>
|
|
<li>Server 1
|
|
|
|
<ul>
|
|
<li>User 1 for server 1
|
|
|
|
<ul>
|
|
<li>Group 1 for user 1</li>
|
|
<li>Group 2 for user 1</li>
|
|
<li>Group n for user 1</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>User 2 for server 1
|
|
|
|
<ul>
|
|
<li>Group 1 for user 2</li>
|
|
<li>Group 2 for user 2</li>
|
|
<li>Group n for user 2</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>User n for server 1</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Server 2</li>
|
|
</ul>
|
|
|
|
<p>If the profile type requested is *GROUP, then records are returned as
|
|
follows:</p>
|
|
|
|
<ul>
|
|
<li>Server 1
|
|
|
|
<ul>
|
|
<li>Group 1 for server 1
|
|
|
|
<ul>
|
|
<li>User 1 for group 1</li>
|
|
<li>User 2 for group 1</li>
|
|
<li>User n for group 1</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Group 2 for server 1
|
|
|
|
<ul>
|
|
<li>User 1 for group 2</li>
|
|
<li>User 2 for group 2</li>
|
|
<li>User n for group 2</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Group n for server 1</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Server 2</li>
|
|
</ul>
|
|
|
|
<p>If the profile type
|
|
requested is *USERBASIC, then records are returned as follows:</p>
|
|
|
|
<ul>
|
|
<li>Server 1
|
|
|
|
<ul>
|
|
<li>User 1 for server 1</li>
|
|
<li>User 2 for server 1</li>
|
|
<li>User n for server 1</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
<p>If the profile type
|
|
requested is *GRPBASIC, then records are returned as follows:</p>
|
|
|
|
<ul>
|
|
<li>Server 1
|
|
|
|
<ul>
|
|
<li>Group 1 for server 1</li>
|
|
<li>Group 2 for server 1</li>
|
|
<li>Group n for server 1</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
<p>If the profile type requested is *ALL, then records are returned as
|
|
follows:</p>
|
|
|
|
<ul>
|
|
<li>Server 1
|
|
|
|
<ul>
|
|
<li>Group 1 for server 1</li>
|
|
<li>Group 2 for server 1</li>
|
|
<li>Group n for server 1</li>
|
|
<li>User 1 for server 1</li>
|
|
<li>User 2 for server 1</li>
|
|
<li>User n for server 1</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<p>If the profile type requested is *NONE, then records are returned as
|
|
follows:</p>
|
|
|
|
<ul>
|
|
<li>Domain 1</li>
|
|
<li>Domain 2</li>
|
|
<li>Domain n</li>
|
|
<li>Server 1</li>
|
|
<li>Server 2</li>
|
|
<li>Server n</li>
|
|
</ul>
|
|
|
|
<br>
|
|
|
|
<p>The following tables
|
|
describe the order and format of the data for each record format in the list.
|
|
For detailed descriptions of the fields in the tables,
|
|
see <a href="#HDRDOLUFD1">Field Descriptions</a>.
|
|
</p>
|
|
|
|
<h3><a name="HDRDOLU100">DOLU0100 Record Format</a></h3>
|
|
|
|
<p>The following table defines the structure of each record returned for format
|
|
DOLU0100.</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%">Displacement to next record</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 record</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">Record type</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">Number records to next record same level</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">Number records next lower level</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">Displacement to name</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">Length of name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="center" valign="top">1C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Server type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Enrollment reason</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">36</td>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Member enrollment</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Profile status</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">44</td>
|
|
<td align="center" valign="top">2C</td>
|
|
<td align="left" valign="top">CHAR(50)</td>
|
|
<td align="left" valign="top">Profile description</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">94</td>
|
|
<td align="center" valign="top">5E</td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Enrollment error code</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">100</td>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Message file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">110</td>
|
|
<td align="center" valign="top">6E</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Primary message file library</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">120</td>
|
|
<td align="center" valign="top">78</td>
|
|
<td align="left" valign="top">CHAR(7)</td>
|
|
<td align="left" valign="top">Message ID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">See note</td>
|
|
<td align="center" valign="top">See note</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The
|
|
displacement and length for the name are specified in the corresponding
|
|
displacement and length variables.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>
|
|
<a name="HDRDOLU150">DOLU0150 Record Format</a></h3>
|
|
|
|
<p>The following table defines the structure of each record returned for format
|
|
DOLU0150.</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%">Displacement to next record</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 record</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">Record type</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">Number records to next record same level</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">Number records next lower level</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">Displacement to name</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">Length of name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="center" valign="top">1C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Server type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Enrollment reason</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">36</td>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Member enrollment</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Profile status</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">44</td>
|
|
<td align="center" valign="top">2C</td>
|
|
<td align="left" valign="top">CHAR(50)</td>
|
|
<td align="left" valign="top">Profile description</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">94</td>
|
|
<td align="center" valign="top">5E</td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Enrollment error code</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">100</td>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Message file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">110</td>
|
|
<td align="center" valign="top">6E</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Primary message file library</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">120</td>
|
|
<td align="center" valign="top">78</td>
|
|
<td align="left" valign="top">CHAR(7)</td>
|
|
<td align="left" valign="top">Message ID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">127</td>
|
|
<td align="center" valign="top">7F</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">128</td>
|
|
<td align="center" valign="top">80</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Displacement to Windows name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">132</td>
|
|
<td align="center" valign="top">84</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of Windows name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">See note</td>
|
|
<td align="center" valign="top">See note</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">See note</td>
|
|
<td align="center" valign="top">See note</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Windows name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The
|
|
displacement and length for the name and Windows name are specified
|
|
in the corresponding displacement and length variables.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<br>
|
|
<br>
|
|
|
|
<h3>
|
|
<a name="HDRDOLU200">DOLU0200 Record Format</a></h3>
|
|
|
|
<p>The following table defines the structure of each record returned for format
|
|
DOLU0200.</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%">Displacement to next record</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 record</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">Record type</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">Number records to next record same level</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">Number records next lower level</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">Displacement to name</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">Length of name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="center" valign="top">1C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Server type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Enrollment reason</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">36</td>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Member enrollment</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Profile status</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">See note</td>
|
|
<td align="center" valign="top">See note</td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The
|
|
displacement and length for the name are specified
|
|
in the corresponding displacement and length variables.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<br>
|
|
<br>
|
|
|
|
<h3><a name="HDRDOLUFD1">DOLU0100,
|
|
DOLU0150, and DOLU0200
|
|
Record Field Descriptions</a></h3>
|
|
|
|
<p><strong>Displacement to name.</strong> The displacement in bytes from the
|
|
beginning of the record to the name.</p>
|
|
|
|
<p><strong>Displacement to next record.</strong> The displacement in bytes from
|
|
the beginning of the record to the next record. If this is the last record,
|
|
this value will be zero.</p>
|
|
|
|
<p>
|
|
<strong>Displacement to Windows name.</strong> The displacement in bytes from the
|
|
beginning of the record to the Windows name.
|
|
This field is set to zero if the enrolled i5/OS user name
|
|
and the Windows user name are the same.
|
|
</p>
|
|
|
|
<p><strong>Enrollment error code.</strong> This value is only specified if the
|
|
record is a <strong>user</strong> or <strong>group</strong> type record.
|
|
Normally it is blank, but it will be set to the last enrollment error code that
|
|
was received while attempting to create, delete, or update a user on a server.
|
|
This should only be non-blank if the profile is in one of the recovery or
|
|
delete statuses.</p>
|
|
|
|
<p>The enrollment error codes are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>239</em></td>
|
|
<td align="left" valign="top">User enrollment failed because the password can
|
|
not be retrieved.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>240</em></td>
|
|
<td align="left" valign="top">Password not available for user enrollment create.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>241</em></td>
|
|
<td align="left" valign="top">Invalid Windows profile name.
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>245</em></td>
|
|
<td align="left" valign="top">User enrollment failed because the password can
|
|
not be retrieved.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>247</em></td>
|
|
<td align="left" valign="top">Update of group failed because domain group type
|
|
cannot be changed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>248</em></td>
|
|
<td align="left" valign="top">Unable to delete user from Windows domain or
|
|
server.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>249</em></td>
|
|
<td align="left" valign="top">Unable to delete group from Windows domain or
|
|
server.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>260</em></td>
|
|
<td align="left" valign="top">User not created because specified name is a
|
|
reserved name in Windows.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>261</em></td>
|
|
<td align="left" valign="top">Group not created because specified name is a
|
|
reserved name in Windows.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>262</em></td>
|
|
<td align="left" valign="top">User not deleted because specified name is a
|
|
reserved name in Windows.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>263</em></td>
|
|
<td align="left" valign="top">Group not deleted because specified name is a
|
|
reserved name in Windows.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>264</em></td>
|
|
<td align="left" valign="top">Enrollment request cannot complete because domain
|
|
controller not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>265</em></td>
|
|
<td align="left" valign="top">User not created because user template not
|
|
found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>266</em></td>
|
|
<td align="left" valign="top">User not created because user name already
|
|
exists.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>267</em></td>
|
|
<td align="left" valign="top">Create or update of user failed for an unknown
|
|
reason.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>268</em></td>
|
|
<td align="left" valign="top">Create or update of group failed for an unknown
|
|
reason.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>269</em></td>
|
|
<td align="left" valign="top">User was created or updated successfully on
|
|
Windows. The user, however, was not added to the AS400_Users group on
|
|
Windows.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>270</em></td>
|
|
<td align="left" valign="top">A request to delete the user from Windows failed
|
|
because the user is a member of the AS400_Permanent_Users group on
|
|
Windows.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>271</em></td>
|
|
<td align="left" valign="top">A request to delete the group from Windows failed
|
|
because the group is not empty on Windows.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>272</em></td>
|
|
<td align="left" valign="top">Add user to an enrolled group failed on
|
|
Windows.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>273</em></td>
|
|
<td align="left" valign="top">Create failed because user or group already
|
|
exists on Windows.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>274</em></td>
|
|
<td align="left" valign="top">Add user to a group listed in the user template
|
|
failed on Windows.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>275</em></td>
|
|
<td align="left" valign="top">User successfully enrolled, but not marked as
|
|
enrolled on Windows.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>276</em></td>
|
|
<td align="left" valign="top">Group successfully enrolled, but not marked as
|
|
enrolled on Windows.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>277</em></td>
|
|
<td align="left" valign="top">User unenrolled, but still marked as an enrolled
|
|
user on Windows.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>278</em></td>
|
|
<td align="left" valign="top">Group unenrolled, but still marked as an enrolled
|
|
group on Windows.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>279</em></td>
|
|
<td align="left" valign="top">Create or update of user failed on Windows;
|
|
password not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>280</em></td>
|
|
<td align="left" valign="top">Create or update user failed. A network server
|
|
description (NWSD) associated with the Windows domain or server must be varied
|
|
on.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>281</em></td>
|
|
<td align="left" valign="top">Enrollment request to local server not valid on
|
|
domain controller.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>282</em></td>
|
|
<td align="left" valign="top">Service not authorized to manage domain groups
|
|
and users on the domain.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>296</em></td>
|
|
<td align="left" valign="top">Unable to create home directory for user.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>452</em></td>
|
|
<td align="left" valign="top">More than one EIM identifier defined for i5/OS user.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>454</em></td>
|
|
<td align="left" valign="top">More than one EIM Windows user profile source association defined.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>459</em></td>
|
|
<td align="left" valign="top">EIM processing error for user.
|
|
</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<p><strong>Enrollment reason.</strong> This value is specified only if the
|
|
record is a <strong>user</strong> type record. It indicates why a profile has
|
|
been selected for enrollment:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The user is a member of a group that has enrolled
|
|
members.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">The user is specifically enrolled to a domain or
|
|
server.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Length of name.</strong> The length of the name.</p>
|
|
|
|
<p><strong>Length of record.</strong> The length of the data for the current
|
|
record.</p>
|
|
|
|
<p>
|
|
<strong>Length of Windows name.</strong> The length of the Windows name.
|
|
This field is set to zero if the enrolled i5/OS user name
|
|
and the Windows user name are the same.
|
|
</p>
|
|
|
|
<p><strong>Member enrollment.</strong> This value is specified only if the
|
|
record is a group type record. It indicates whether group members are
|
|
enrolled.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Group members are not enrolled.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Group members are enrolled.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Message file.</strong> This value is specified only if the record is
|
|
a <strong>user</strong> or <strong>group</strong> type record. The message file
|
|
that contains the message ID for a message that describes the enrollment error
|
|
code for a failed enrollment operation.</p>
|
|
|
|
<p><strong>Message ID.</strong> This value is specified only if the record is a
|
|
<strong>user</strong> or <strong>group</strong> type record. The message that
|
|
describes the enrollment error code for a failed enrollment operation.</p>
|
|
|
|
<p><strong>Name.</strong> The name of a Windows domain or server,
|
|
or an enrolled i5/OS user or group, depending on the record type.</p>
|
|
|
|
<p><strong>Usage note:</strong> Avoid the use of characters '5B'X, '7B'X, and
|
|
'7C'X (CCSID 37 characters '$', '#', and '@', respectively) in user and group
|
|
profile names.</p>
|
|
|
|
<p><strong>Number records next lower level.</strong> The number of sub-records
|
|
that exist for a record. For example, if the current record is a group record,
|
|
followed by three user records for that group, then the number of records next
|
|
lower level would be three.</p>
|
|
|
|
<p><strong>Number records to next record same level.</strong> The number of
|
|
records to traverse to locate the next record of the same type (server, user,
|
|
or group). If there are no more records of the same type, this value is
|
|
zero.</p>
|
|
|
|
<p>For example, if the current record is a group record, followed by three user
|
|
records for the group, followed by another group record, then the number of
|
|
records to next record same level would be four.</p>
|
|
|
|
<p><strong>Primary message file library.</strong> The library that contains the
|
|
message file. This value is specified only if the record is a user or group
|
|
type record.</p>
|
|
|
|
<p><strong>Note:</strong> If the message text is retrieved, use *LIBL (library
|
|
list) as the message file library so that the correct national language version
|
|
of the message text is retrieved. If the message file returned by this API is
|
|
not in any of libraries in the library list, then message retrieval operation
|
|
will fail with message CPF2407 "Message file x in *LIBL not found." If this
|
|
occurs, then attempt the retrieval operation again, using the primary message
|
|
file library that is returned by this API.</p>
|
|
|
|
<p><strong>Profile description.</strong> The description for this profile. This
|
|
value is specified only if the record is a <strong>user</strong> or <strong>
|
|
group</strong> type record.</p>
|
|
|
|
<p><strong>Profile status.</strong> The current status of a user or group on a
|
|
server. This value is specified only if the record is a user or group type
|
|
record. The following values represent the various status values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Profile is enrolled on the server
|
|
(up-to-date).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Enrollment pending on the server.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">Enrollment retry pending on the server.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>4</em></td>
|
|
<td align="left" valign="top">Enrollment failed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>5</em></td>
|
|
<td align="left" valign="top">Unenrollment pending on the server.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>6</em></td>
|
|
<td align="left" valign="top">Unenrollment retry pending on the server.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>7</em></td>
|
|
<td align="left" valign="top">Unenrollment failed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>8</em></td>
|
|
<td align="left" valign="top">Only group members enrolled. The users in the
|
|
group are enrolled to the servers, but the group itself is not enrolled to the
|
|
servers. This status is valid only for a group.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>9</em></td>
|
|
<td align="left" valign="top">Profile is enrolled on the server using the
|
|
i5/OS profile name. An error occured when looking up the Windows user
|
|
name using Enterprise Identity Mapping (EIM).
|
|
</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<p><strong>Record type.</strong> The record type for a record. The values that
|
|
represent the various types follow:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">A server type record.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">A user type record.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">A group type record.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Note:</strong> The first record in the list is always a server type
|
|
record.</p>
|
|
|
|
<p>
|
|
<strong>Reserved.</strong> Reserved area for 4-byte boundary alignment.
|
|
</p>
|
|
|
|
<p><strong>Server type.</strong> The type of server represented by the record.
|
|
This value is specified only if the record is a <strong>server</strong> type
|
|
record.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">A Windows domain.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">A Windows server.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<p>
|
|
<strong>Windows name.</strong> The name of the user on Windows.
|
|
This field is not returned if the enrolled i5/OS user name
|
|
and the Windows user name are the same.</p>
|
|
<p><strong>Note: </strong>
|
|
The Windows user name could be different than the enrolled i5/OS user name
|
|
if Enterprise Identity Mapping (EIM) is used for the enrolled user.
|
|
</p>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRODOLUI"></a>Format of List Information</h3>
|
|
|
|
<p>The following table shows the format of the list information parameter. For
|
|
detailed descriptions of the field in the table, see <a href="#HDRFPADOLL">
|
|
Field Descriptions</a>.</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%">Total records</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">Records returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">CHAR(4)</td>
|
|
<td align="left" valign="top">Request handle</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">Record length</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Information complete indicator</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">17</td>
|
|
<td align="center" valign="top">11</td>
|
|
<td align="left" valign="top">CHAR(13)</td>
|
|
<td align="left" valign="top">Date and time created</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="center" valign="top">1E</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">List status indicator</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">31</td>
|
|
<td align="center" valign="top">1F</td>
|
|
<td align="left" valign="top">CHAR(1)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of information returned</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">36</td>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">First record in buffer</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="center" valign="top">28</td>
|
|
<td align="left" valign="top">CHAR(40)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRFPADOLL">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Date and time created.</strong> The date and time the list was
|
|
created. The 13 characters are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>11</em></td>
|
|
<td align="left" valign="top">Century, where 0 indicates years 19<em>xx</em>
|
|
and 1 indicates years 20<em>xx</em>.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2-7</em></td>
|
|
<td align="left" valign="top">The date, in YYMMDD (year, month, day)
|
|
format.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>8-13</em></td>
|
|
<td align="left" valign="top">The time of day, in HHMMSS (hours, minutes,
|
|
seconds) format.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>First record in buffer.</strong> The number of the first record in
|
|
the receiver variable.</p>
|
|
|
|
<p><strong>Information complete indicator.</strong> Whether all information
|
|
requested has been supplied.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>I</em></td>
|
|
<td align="left" valign="top">Incomplete information. An interruption caused
|
|
the list to contain incomplete information about a buffer or buffers.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>P</em></td>
|
|
<td align="left" valign="top">Partial and accurate information. Partial
|
|
information is returned when the maximum space was used and not all of the
|
|
buffers requested were read.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>C</em></td>
|
|
<td align="left" valign="top">Complete and accurate information. All the
|
|
buffers requested were read and returned.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Length of information returned.</strong> The size, in bytes, of the
|
|
information returned in the receiver variable.</p>
|
|
|
|
<p><strong>List status indicator.</strong> The status of the list building. The
|
|
indicators are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The list building is pending.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The list is in the process of being built.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">The list has been built completely.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">An error occurred while building the list. The
|
|
next call to QGYGTLE will cause the error to be signalled to the caller of
|
|
QGYGTLE.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Record length.</strong> The length of each record of information
|
|
returned. For variable length records, this value is set to 0. For variable
|
|
length records, you can obtain the length of individual records from the
|
|
records themselves.</p>
|
|
|
|
<p><strong>Records returned.</strong> The number of records returned in the
|
|
receiver variable. This is the smallest of the following values:</p>
|
|
|
|
<ul>
|
|
<li>The number of records that fit into the receiver variable.</li>
|
|
|
|
<li>The number of records in the list.</li>
|
|
|
|
<li>The number of records requested.</li>
|
|
</ul>
|
|
|
|
<p><strong>Request handle.</strong> The handle of the request that can be used
|
|
for subsequent requests of information from the list. The handle is valid until
|
|
the Close List (QGYCLST) API is called to close the list or until the job
|
|
ends.</p>
|
|
|
|
<p><strong>Note:</strong> This field should be treated as a hexadecimal field.
|
|
It should not be converted from one CCSID to another (for example, EBCDIC to
|
|
ASCII) because doing so could result in an unusable value.</p>
|
|
|
|
<p><strong>Reserved.</strong> Reserved field. Must be set to hexadecimal or
|
|
binary zero.</p>
|
|
|
|
<p><strong>Total records.</strong> The total number of records available in the
|
|
list.</p>
|
|
|
|
<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 valign="top" width="15%">CPFA314 E</td>
|
|
<td valign="top" width="85%">Memory allocation error.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF24B4 E</td>
|
|
<td valign="top">Severe error while addressing parameter list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF2634 E</td>
|
|
<td valign="top">Not authorized to object &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C19 E</td>
|
|
<td valign="top">Error occurred with receiver variable specified.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C1D E</td>
|
|
<td valign="top">Length specified in parameter &1 not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C21 E</td>
|
|
<td valign="top">Format name &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C36 E</td>
|
|
<td valign="top">Number of parameters, &1, entered for this API was not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C3C E</td>
|
|
<td valign="top">Value for parameter &1 not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3CF1 E</td>
|
|
<td valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3CF2 E</td>
|
|
<td valign="top">Error(s) occurred during running of &1 API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9872 E</td>
|
|
<td valign="top">Program or service program &1 in library &2 ended.
|
|
Reason code &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9999 E</td>
|
|
<td valign="top">Function check. &1 unmonitored by &2 at statement
|
|
&5, instruction &3.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<hr>
|
|
API introduced: V5R1
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"ss1.htm">Server Support APIs</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|