1674 lines
49 KiB
HTML
1674 lines
49 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>Retrieve Directory Server Attributes (QgldRtvDirSvrA)</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. -->
|
|
<!-- Direct1 SCRIPT J converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
|
|
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
|
|
<!--File Edited April 2001 -->
|
|
<!-- This file has undergone html cleanup on 2/21/02 by JET -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- 040920 ROCH User needs both *ALLOBJ and *AUDIT to retrieve -->
|
|
<!-- Server Auditing Information, format RSVR0700 -->
|
|
<!--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>Retrieve Directory Server Attributes (QgldRtvDirSvrA)</h2>
|
|
|
|
<div class="box" style="width: 65%;">
|
|
<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="50%">Receiver variable</td>
|
|
<td align="left" valign="top" width="20%">Output</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 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">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">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>
|
|
Library Name/Service Program: QSYS/QGLDUAPI<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Retrieve Directory Server Attributes (QgldRtvDirSvrA) API retrieves
|
|
information about the directory server configuration. It can be used to
|
|
retrieve information about:</p>
|
|
|
|
<ul>
|
|
<li>General server properties</li>
|
|
|
|
<li>Encrypted communications configuration. The Secure Sockets Layer (SSL) is
|
|
used for encrypted communications.</li>
|
|
|
|
<li>Performance settings</li>
|
|
|
|
<li>Auditing settings</li>
|
|
</ul>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<p><!-- Begin V5R4 change --> <img src="delta.gif" alt="Start of change">
|
|
To retrieve format RSVR0700, Server auditing information, the caller of this API must have either *ALLOBJ or *AUDIT special authorities.</p>
|
|
<p>For all other formats, no i5/OS special authority is required.<img
|
|
src="deltaend.gif" alt="End of change"><!-- End V5R4 change --></p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRGRSPRPG">Required Parameter Group</a></h3>
|
|
|
|
<dl>
|
|
<dt><strong>Receiver variable</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>The variable to receive output data. See <a href="#HDRGRSPFMT">Format of
|
|
Output Data</a> for a description of the format of the output data associated
|
|
with a specific format name.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the receiver variable area.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The format name identifying the type of information to be retrieved.
|
|
The possible format names follow:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>RSVR0100</em></td>
|
|
<td align="left" valign="top">Basic server configuration</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>RSVR0400</em></td>
|
|
<td align="left" valign="top">Attributes for publishing users in an LDAP directory</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>RSVR0700</em></td>
|
|
<td valign="top">Server auditing information</td>
|
|
</tr>
|
|
|
|
<!-- Begin V5R3 change -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>RSVR0900</em></td>
|
|
<td valign="top">Server administration information</td>
|
|
</tr>
|
|
<!-- End V5R3 change -->
|
|
</table>
|
|
|
|
<p>See <a href="#HDRGRSPFMT">Format of Output 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="HDRGRSPFMT">Format of Output Data</a></h3>
|
|
|
|
<p>For details about the format of the output data, see the following sections.
|
|
For details about the fields in each format, see <a href="#HDRGRSPFLD">Field
|
|
Descriptions</a>.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>RSVR0100 Format</h3>
|
|
|
|
<p>This format is used to retrieve basic server configuration information.</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="top">Dec</th>
|
|
<th align="center" valign="top">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%">Bytes returned</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">Bytes available</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">Version</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">Read only</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">Server is replica</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">Security</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">Unencrypted port number</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">Encrypted port number</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">Current cipher protocols</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">Installed cipher protocols</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">Search time limit</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">44</td>
|
|
<td align="center" valign="top">2C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Search size limit</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Maximum connections</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">52</td>
|
|
<td align="center" valign="top">34</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">56</td>
|
|
<td align="center" valign="top">38</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Referral port</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">60</td>
|
|
<td align="center" valign="top">3C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Password format</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to referral server</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">68</td>
|
|
<td align="center" valign="top">44</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of referral server</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">72</td>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to administrator distinguished name
|
|
(DN)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">76</td>
|
|
<td align="center" valign="top">4C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of administrator DN</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">80</td>
|
|
<td align="center" valign="top">50</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to update DN</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">84</td>
|
|
<td align="center" valign="top">54</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of update DN</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">88</td>
|
|
<td align="center" valign="top">58</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">92</td>
|
|
<td align="center" valign="top">5C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">96</td>
|
|
<td align="center" valign="top">60</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to database path</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">100</td>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of database path</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">104</td>
|
|
<td align="center" valign="top">68</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">108</td>
|
|
<td align="center" valign="top">6C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">SSL authentication method</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">112</td>
|
|
<td align="center" valign="top">70</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of database connections</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">116</td>
|
|
<td align="center" valign="top">74</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Schema checking level</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">120</td>
|
|
<td align="center" valign="top">78</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to master server URL</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">124</td>
|
|
<td align="center" valign="top">7C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of master server URL</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">Change log indicator</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">Maximum number of change log entries</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">136</td>
|
|
<td align="center" valign="top">88</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Terminate idle connections</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">140</td>
|
|
<td align="center" valign="top">8C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Kerberos authentication indicator</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">144</td>
|
|
<td align="center" valign="top">90</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to Kerberos key tab file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">148</td>
|
|
<td align="center" valign="top">94</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of Kerberos key tab file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">152</td>
|
|
<td align="center" valign="top">98</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Kerberos to DN mapping indicator</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">156</td>
|
|
<td align="center" valign="top">9C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to Kerberos administrator ID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">160</td>
|
|
<td align="center" valign="top">A0</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of Kerberos administrator ID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">164</td>
|
|
<td align="center" valign="top">A4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to Kerberos administrator realm</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">168</td>
|
|
<td align="center" valign="top">A8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of Kerberos administrator realm</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">172</td>
|
|
<td align="center" valign="top">AC</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Event notification registration indicator</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">176</td>
|
|
<td align="center" valign="top">B0</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Maximum event registrations for connection</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">180</td>
|
|
<td align="center" valign="top">B4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Maximum event registrations for server</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">184</td>
|
|
<td align="center" valign="top">B8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Maximum operations per transaction</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">188</td>
|
|
<td align="center" valign="top">BC</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Maximum pending transactions</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">192</td>
|
|
<td align="center" valign="top">C0</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Transaction time limit</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">196</td>
|
|
<td align="center" valign="top">C4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">ACL model</td>
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
<td align="center" valign="top">200</td>
|
|
<td align="center" valign="top">C8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Level of authority integration</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">204</td>
|
|
<td align="center" valign="top">CC</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to projected suffix</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">208</td>
|
|
<td align="center" valign="top">D0</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of projected suffix</td>
|
|
</tr>
|
|
|
|
<!-- Begin V5R3 change -->
|
|
<tr>
|
|
<td align="center" valign="top">212</td>
|
|
<td align="center" valign="top">D4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Read only schema</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">216</td>
|
|
<td align="center" valign="top">D8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Read only projected suffix</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">220</td>
|
|
<td align="center" valign="top">DC</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Log client messages</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">224</td>
|
|
<td align="center" valign="top">E0</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Maximum age of change log entries</td>
|
|
</tr>
|
|
<!-- End V5R3 change -->
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Referral server</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Administrator DN</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Update DN</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Database path</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Master server URL</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Kerberos key tab file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Kerberos administrator ID</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Kerberos administrator realm</td>
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Projected suffix</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>RSVR0400 Format</h3>
|
|
|
|
<p>This format is used to retrieve the attributes for publishing users in an
|
|
LDAP directory. User information from the system distribution directory can be
|
|
published to an LDAP server by the Synchronize System Distribution Directory to
|
|
LDAP (QGLDSSDD) API and from iSeries Navigator. The publishing attributes
|
|
define how to publish user information.</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="top">Dec</th>
|
|
<th align="center" valign="top">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%">Bytes returned</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">Bytes available</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 server 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 server 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">LDAP port number</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">Connection type</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">Offset to parent distinguished 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">Length of parent distinguished name.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Server name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Parent distinguished name.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>RSVR0700 Format</h3>
|
|
|
|
<p>This format is used to retrieve server auditing configuration
|
|
information.</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="top">Dec</th>
|
|
<th align="center" valign="top">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%">Bytes returned</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">Bytes available</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">Security audit option for objects</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<!-- Begin V5R3 change -->
|
|
|
|
<h3>RSVR0900 Format</h3>
|
|
|
|
<p>This format is used to retrieve server administration
|
|
information.</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%">Bytes returned</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">Bytes available</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">8</td>
|
|
<td align="center" valign="top" width="10%">8</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Offset to server administration URL</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 server administration URL</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Server administration URL</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<!-- End V5R3 change -->
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRGRSPFLD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>ACL model.</strong> The ACL model that is being used.
|
|
The following special values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The ACL model being used supports access-class
|
|
level permissions. This is the ACL model the directory server used prior to
|
|
V5R1M0.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The ACL model being used supports both access-class level
|
|
permissions and attribute-level ACL permissions.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Administrator DN.</strong> A distinguished name (DN) that has access
|
|
to all objects in the directory. This field is specified in UTF-16 (CCSID
|
|
13488).</p>
|
|
|
|
<p><strong>Bytes available.</strong> The number of bytes of data available to
|
|
be returned. All available data is returned if enough space is provided.</p>
|
|
|
|
<p><strong>Bytes returned.</strong> The number of bytes of data returned.</p>
|
|
|
|
<p><strong>Change log indicator.</strong> The indicator of whether a change log
|
|
exists for entries that have been added, changed and deleted.
|
|
The following values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">No, a change log does not exist</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Yes, a change log exists</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Connection type.</strong> The type of connection to use to the LDAP
|
|
server. The following values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Nonsecure</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Secured, using SSL</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Current cipher protocols.</strong> The cipher protocols that the
|
|
server allows when using encrypted connections.
|
|
The value is the sum of zero or more of the following values:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0x0100</em></td>
|
|
<td align="left" valign="top">Triple Data Encryption Standard (DES) Secure Hash
|
|
Algorithm (SHA) (U.S.)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>0x0200</em></td>
|
|
<td align="left" valign="top">DES SHA (U.S)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>0x0400</em></td>
|
|
<td align="left" valign="top">Rivest Cipher 4 (RC4) SHA (U.S.)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>0x0800</em></td>
|
|
<td align="left" valign="top">RC4 Message Digest (MD) 5 (U.S.)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>0x1000</em></td>
|
|
<td align="left" valign="top">RC2 MD5 (export)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>0x2000</em></td>
|
|
<td align="left" valign="top">RC4 MD5 (export)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>0x4000</em></td>
|
|
<td align="left" valign="top">Advanced Encryption Standard (AES) SHA 128 bit (U.S.)
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">
|
|
<img src="delta.gif" alt="Start of change"><em>0x8000</em>
|
|
</td>
|
|
<td align="left" valign="top">Advanced Encryption Standard (AES) SHA 256 bit (U.S.)
|
|
<img src="deltaend.gif" alt="End of change">
|
|
</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<p><strong>Database path.</strong> The integrated file system path name of the
|
|
library containing the directory database. This field is specified in UTF-16
|
|
(CCSID 13488).</p>
|
|
|
|
<p><strong>Encrypted port number.</strong> The port number to use for encrypted
|
|
connections. The standard port number for encrypted connections is 636.</p>
|
|
|
|
<p><strong>Event notification registration indicator.</strong> Indicator of
|
|
whether to allow client to register for event notification.
|
|
The following special values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Do not allow clients to register for event
|
|
notification.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Allow clients to register for event notification.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Installed cipher protocols.</strong> The cipher protocols installed
|
|
on the system. Refer to the current cipher protocols field for a description of
|
|
the values.</p>
|
|
|
|
<p><strong>Kerberos administrator ID.</strong> The name of the Kerberos
|
|
administrator. This field is specified in UTF-16 (CCSID 13488).
|
|
The following special value may be returned:</p>
|
|
|
|
<table width="100%">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NONE</em></td>
|
|
<td align="left" valign="top">No value is specified.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Kerberos administrator realm.</strong> The realm in which the kerberos
|
|
administrator is registered. This field is specified in UTF-16 (CCSID
|
|
13488). The following special value may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NONE</em></td>
|
|
<td align="left" valign="top">No value is specified.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Kerberos authentication indicator.</strong> The following special
|
|
values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Do not support Kerberos authentications.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Support Kerberos authentications.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Kerberos key tab file.</strong> The integrated file system path name
|
|
for the key tab file that contains the server's secret key used for
|
|
authentication. This field is specified in UTF-16 (CCSID 13488).
|
|
The following special value may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NONE</em></td>
|
|
<td align="left" valign="top">No value is specified.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Kerberos to DN mapping indicator.</strong></p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Map the Kerberos ID to pseudo DN. A pseudo DN can
|
|
be used to uniquely identify an LDAP user object of the form
|
|
'ibm-kerberosName=principal@realm' or 'ibm-kn=principal@realm'.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Use associated DN in directory. The LDAP server will attempt
|
|
to find an entry in the directory that contains the kerberos principle and
|
|
realm as one of its attributes. Once found, this DN will then be used to
|
|
determine the client's authorizations to the directory.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>LDAP port number.</strong> The LDAP server's TCP/IP port.</p>
|
|
|
|
<p><strong>Length of administrator DN.</strong> The length, in UTF-16 (CCSID 13488)
|
|
characters, of the administrator DN field.</p>
|
|
|
|
<p><strong>Length of database path.</strong> The length, in UTF-16 (CCSID 13488) characters,
|
|
of the database path field.</p>
|
|
|
|
<p><strong>Length of Kerberos administrator ID.</strong> The length, in UTF-16 (CCSID 13488)
|
|
characters, of the Kerberos Administrator ID field.</p>
|
|
|
|
<p><strong>Length of Kerberos administrator realm.</strong> The length, in
|
|
UTF-16 (CCSID 13488) characters, of the Kerberos administrator realm field.</p>
|
|
|
|
<p><strong>Length of Kerberos key tab file.</strong> The length, in UTF-16 (CCSID 13488)
|
|
characters, of the Kerberos key tab file field.</p>
|
|
|
|
<p><strong>Length of master server URL.</strong> The length, in UTF-16 (CCSID 13488)
|
|
characters, of the master server URL field.</p>
|
|
|
|
<p><strong>Length of parent distinguished name.</strong> The length, in UTF-16 (CCSID 13488)
|
|
characters, of the parent distinguished name field.</p>
|
|
|
|
|
|
<p><strong>Length of projected
|
|
suffix.</strong> The length, in UTF-16 (CCSID 13488) characters, of the projected suffix
|
|
field </p>
|
|
|
|
<!-- Begin V5R3 change -->
|
|
<p><strong>Length of server administration URL.</strong> The length, in UTF-16 (CCSID 13488) characters, of the server administration URL field.
|
|
</p>
|
|
<!-- End V5R3 change -->
|
|
|
|
<p><strong>Length of server name.</strong> The length, in UTF-16 (CCSID 13488) characters,
|
|
of the server name field.</p>
|
|
|
|
<p><strong>Length of referral server.</strong> The length, in UTF-16 (CCSID 13488)
|
|
characters, of the referral server field.</p>
|
|
|
|
<p><strong>Length of update DN.</strong> The length, in UTF-16 (CCSID 13488) characters, of
|
|
the update DN field.</p>
|
|
|
|
|
|
<p><strong>Level of authority
|
|
integration.</strong> The level of i5/OS authority integration to use to
|
|
determine if a distinguished name (DN) can become an LDAP administrator. The
|
|
following special values may be specified:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Do not apply 'Directory Server Administrator'
|
|
(QIBM_DIRSRV_ADMIN) function identifier to bound distinguished names to
|
|
determine LDAP administrators.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Allow bound distinguished names that refer
|
|
directly to user profiles to become LDAP administrators if the user profile is
|
|
identified in the 'Directory Server Administrator' (QIBM_DIRSRV_ADMIN)
|
|
function identifier. </td>
|
|
|
|
</tr>
|
|
</table>
|
|
|
|
<!-- Begin V5R3 change -->
|
|
<p>
|
|
<strong> Log client messages.</strong> Whether the directory server will log client messages in the server joblog. The following values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The directory server will not log client messages in the server joblog.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The directory server will log client messages in the server joblog.</td>
|
|
</tr>
|
|
</table>
|
|
<!-- End V5R3 change -->
|
|
|
|
<p><strong>Master server URL.</strong> The uniform resource locator (URL) of
|
|
the master server. This field is specified in UTF-16 (CCSID 13488).
|
|
The following special value may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NONE</em></td>
|
|
<td align="left" valign="top">No value is specified.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Maximum connections.</strong> Returns the maximum number of
|
|
simultaneous connections that can be established with the server.</p>
|
|
|
|
<p>Starting with V5R1M0, this field is no longer supported and the value
|
|
returned is 0. The following special value may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Do not limit the number of connections.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Maximum event registrations for connection.</strong>
|
|
The following special values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Do not limit the number of event registrations for
|
|
connection.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Maximum event registrations for server.</strong>
|
|
The following special values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Do not limit the number of event registrations for
|
|
server.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<!-- Begin V5R3 change -->
|
|
<p><strong>Maximum age of change log entries.</strong> The age, in seconds, of
|
|
change log entries that can be stored. If the maximum is reached, the change
|
|
log entries will be deleted starting with the oldest entry. This value only
|
|
valid if 'Change log indicator' is set to 1.
|
|
The following special values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The age of change log entries is not
|
|
limited.</td>
|
|
</tr>
|
|
</table>
|
|
<!-- End V5R3 change -->
|
|
|
|
<p><strong>Maximum number of change log entries.</strong> The maximum number of
|
|
change log entries that can be stored. If the maximum is reached, the change
|
|
log entries will be deleted starting with the oldest entry. This value only
|
|
valid if 'Change log indicator' is set to 1.
|
|
The following special values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The number of change log entries is not
|
|
limited.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Maximum operations per transaction.</strong> The maximum number of
|
|
operations that are allowed for each transaction. Transaction support allows a
|
|
group of directory changes to be handled as a single transaction.</p>
|
|
|
|
<p><strong>Maximum pending transactions.</strong> The maximum number of pending
|
|
transactions allowed. Transaction support allows a group of directory changes
|
|
to be handled as a single transaction.</p>
|
|
|
|
<p><strong>Number of database connections.</strong> The number of database
|
|
connections used by the server.</p>
|
|
|
|
<p><strong>Offset to administrator DN.</strong> The offset, in bytes, from the
|
|
start of the receiver variable to the administrator DN field.</p>
|
|
|
|
<p><strong>Offset to database path.</strong> The offset, in bytes, from the
|
|
start of the receiver variable to the database path field.</p>
|
|
|
|
<p><strong>Offset to Kerberos administrator ID.</strong> The offset, in bytes,
|
|
from the start of the input data area to the Kerberos administrator ID
|
|
field.</p>
|
|
|
|
<p><strong>Offset to Kerberos administrator realm.</strong> The offset, in
|
|
bytes, from the start of the input data area to the Kerberos administrator
|
|
realm field.</p>
|
|
|
|
<p><strong>Offset to Kerberos key tab file.</strong> The offset, in bytes, from
|
|
the start of the input data area to the Kerberos key tab file field.</p>
|
|
|
|
<p><strong>Offset to master server URL.</strong> The offset, in bytes, from the
|
|
start of the receiver variable to the master server URL field.</p>
|
|
|
|
<p><strong>Offset to parent distinguished name.</strong> The offset, in bytes,
|
|
from the start of the receiver variable to the parent distinguished name
|
|
field.</p>
|
|
|
|
|
|
<p><strong>Offset to projected
|
|
suffix.</strong> The offset, in bytes, from the start of the input data area to
|
|
the projected suffix field. </p>
|
|
|
|
|
|
<p><strong>Offset to referral server.</strong> The offset, in bytes, from the
|
|
start of the receiver variable to the referral server field.</p>
|
|
|
|
<!-- Begin V5R3 change -->
|
|
<p><strong>Offset to server administration URL.</strong> The offset, in bytes, from the start
|
|
of the receiver variable to the server administration URL field.
|
|
</p>
|
|
<!-- End V5R3 change -->
|
|
|
|
<p><strong>Offset to server name.</strong> The offset, in bytes, from the start
|
|
of the receiver variable to the server name field.</p>
|
|
|
|
<p><strong>Offset to update DN.</strong> The offset, in bytes, from the start
|
|
of the receiver variable to the update DN field.</p>
|
|
|
|
<p><strong>Parent distinguished name.</strong> The parent distinguished name
|
|
for published objects. For example, if the parent distinguished name is
|
|
'ou=rochester, o=ibm, c=us', a published directory object for user John Smith
|
|
might be 'cn=john smith, ou=rochester, o=ibm, c=us'. This field is specified in
|
|
UTF-16 (CCSID 13488).</p>
|
|
|
|
<p><strong>Password format.</strong> The format of the encrypted password.
|
|
The following values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Unencrypted. The clear text password is stored
|
|
in a validation list and can be returned by searches or used for DIGEST-MD5
|
|
SASL authentication.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">SHA. (Default)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">MD5.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>4</em></td>
|
|
<td align="left" valign="top">Crypt (The password is one-way hashed using a modified DES
|
|
algorithm. The 'crypt' algorithm originally was used by many UNIX operating
|
|
systems for password protection.)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<p><strong>Projected
|
|
suffix.</strong> The suffix under which all projected objects for this server
|
|
reside including user and group profiles. This field is specified in UTF-16
|
|
(CCSID 13488).</p>
|
|
|
|
|
|
<p><strong>Read only.</strong> Whether the directory server allows changes to
|
|
be made to the directory contents. The following values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The directory server is not read only. Updates are
|
|
allowed to the directory.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The directory server is read only. Updates are not allowed to
|
|
the directory.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<!-- Begin V5R3 change -->
|
|
<p>
|
|
<strong> Read only projected suffix.</strong> Whether the directory server will allow updates to be made to the projected suffix. The following values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The directory server projected suffix is not read only. Updates are allowed to the projected suffix.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The directory server projected suffix is read only. Updates are not allowed to the projected suffix.</td>
|
|
</tr>
|
|
</table>
|
|
<!-- End V5R3 change -->
|
|
|
|
<!-- Begin V5R3 change -->
|
|
<p>
|
|
<strong>Read only schema.</strong> Whether the directory server will allow updates to be made to the directory schema. The following values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The directory server schema is not read only. Updates are allowed to the schema.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The directory server schema is read only. Updates are not allowed to the schema.</td>
|
|
</tr>
|
|
</table>
|
|
<!-- End V5R3 change -->
|
|
|
|
<p><strong>Referral port.</strong> An optional port number to be returned to a
|
|
client when a request is made for a directory object that does not reside on
|
|
this server. The referral port and referral server together are used to form a
|
|
referral URL. The following special value may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The LDAP port is not specified, the client should
|
|
use the default LDAP port.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Referral server.</strong> The IP name of a server to return to a
|
|
client when a request is made for a directory object that does not reside on
|
|
this server. This field is specified in UTF-16 (CCSID 13488). The referral port
|
|
and referral server are used together to form a referral URL.
|
|
The following special value may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NONE</em></td>
|
|
<td align="left" valign="top">No value is specified.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Reserved.</strong> A reserved field. This field must be set to
|
|
zero.</p>
|
|
|
|
<p><strong>Schema checking level.</strong> The level of schema checking
|
|
performed by the server. The following values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">None.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">LDAP version 2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">LDAP version 3 strict.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">LDAP version 3 lenient.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Search size limit.</strong> The maximum number of entries that the
|
|
server will return for a given search request. The following special value may
|
|
be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Do not limit the number of entries returned.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Search time limit.</strong> The maximum time, in seconds, that the
|
|
server will spend performing a given search request.
|
|
The following special value may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Do not limit the search time.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Security.</strong> Whether the server is to use encrypted
|
|
connections. The following values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Allow unencrypted connections only.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Allow encrypted connections only.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Allow both encrypted and unencrypted connections.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Note:</strong> SSL is used for encrypted connections to the
|
|
server.</p>
|
|
|
|
<p><strong>Security audit option for objects.</strong> When the QAUDCTL system
|
|
value is set to *OBJAUD, then object auditing can be done in the directory. See
|
|
the <a href="../books/sc415302.pdf" target="_blank">iSeries Security
|
|
Reference</a> <img src="wbpdf.gif" alt="Link to PDF">book for information about
|
|
Directory Server auditing. The following special values may be returned: </p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Do not do object auditing of the directory
|
|
objects.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Audit changes to directory objects.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>2</em></td>
|
|
<td align="left" valign="top">Audit all access to directory objects. This includes search,
|
|
compare and change.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Server is replica.</strong> Whether the server is a master server or
|
|
a replica server. The following values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">The server is a master server for the directory
|
|
suffixes present on the server.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">The server is a replica server for the directory suffixes
|
|
present on the server.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<!-- Begin V5R3 change -->
|
|
<p><strong>Server administration URL.</strong> The server administration URL. This field is
|
|
specified in UTF-16 (CCSID 13488).</p>
|
|
<!-- End V5R3 change -->
|
|
|
|
<p><strong>Server name.</strong> The name of the server. This field is
|
|
specified in UTF-16 (CCSID 13488).</p>
|
|
|
|
<p><strong>SSL authentication method.</strong> The method used during SSL
|
|
authentication. The following values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Server authentication.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>3</em></td>
|
|
<td align="left" valign="top">Server and client authentication.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Terminate idle connections.</strong> The server will terminate idle
|
|
connections when necessary. The following values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Do not terminate idle connections.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Terminate idle connections.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Note:</strong> Starting with V5R1M0, this field is no longer
|
|
supported and the value returned is 0.</p>
|
|
|
|
<p><strong>Transaction time limit.</strong> The maximum time, in seconds, that
|
|
the server will spend performing a transaction request. Transaction support
|
|
allows a group of directory changes to be handled as a single transaction.</p>
|
|
|
|
<p><strong>Unencrypted port number.</strong> The port number to be used for
|
|
unencrypted connections. The standard port number is 389.</p>
|
|
|
|
<p><strong>Update DN.</strong> The distinguished name that the master server
|
|
must use when propagating directory updates to this replica server. This field
|
|
is specified in UTF-16 (CCSID 13488). The following value may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NONE</em></td>
|
|
<td align="left" valign="top">No value is specified.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Use encrypted connections.</strong> Whether this server should use
|
|
encrypted connections when making updates to the replica server.
|
|
The following values may be returned:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Use unencrypted connections.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">Use encrypted connections.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Version.</strong> Returns the version of the LDAP server.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top" nowrap>Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA314 E</td>
|
|
<td align="left" valign="top">Memory allocation error.</td>
|
|
</tr>
|
|
|
|
<!-- Begin V5R4 change -->
|
|
<tr>
|
|
<td align="left" valign="top"><img src="delta.gif" alt="Start of change">GLD016E E</td>
|
|
<td align="left" valign="top">*ALLOBJ or *AUDIT special authority required.
|
|
<img src="deltaend.gif" alt="End of change"></td>
|
|
</tr>
|
|
<!-- End V5R4 change -->
|
|
|
|
<tr>
|
|
<td align="left" valign="top">GLD0215 E</td>
|
|
<td align="left" valign="top">Server has not been configured.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<br>
|
|
|
|
<hr>
|
|
API introduced: V4R3
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> |
|
|
<a href="unix.htm">UNIX-Type APIs</a> |
|
|
<a href="aplist.htm">APIs by category</a> </td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|