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

3177 lines
94 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Change Directory Server Attributes (QgldChgDirSvrA)</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 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited April 2001 -->
<!-- This file has undergone html cleanup on 2/21/02 by JET -->
<!--End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="top_Of_Page"></a>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Change Directory Server Attributes (QgldChgDirSvrA)</h2>
<div class="box" style="width: 65%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Input data</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Length of input data</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>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Library Name/Service Program: QSYS/QGLDUAPI<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Change Directory Server Attributes (QgldChgDirSvrA) API changes the
directory server configuration. It can be used to change the following server
properties:</p>
<ul>
<li>General server properties</li>
<li>Suffixes served by this server</li>
<li>Encrypted connection configuration. The Secure Sockets Layer (SSL) is used
for encrypted communication.</li>
<li>Performance settings</li>
</ul>
<br>
<h3>Authorities and Locks</h3>
<p>*ALLOBJ and *IOSYSCFG special authority is required to use this API with
formats CSVR0100, CSVR0200, CSVR0300, CSVR0400, CSVR0500, CSVR0600, CSVR0800, or
<!-- Begin V5R3 change -->
CSVR0900.
<!-- End V5R3 change -->
*AUDIT special authority is required to use this API
with format CSVR0700.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Input data</strong></dt>
<dd>INPUT; CHAR(*)
<p>A variable that contains the input data. See <a href="#HDRGCSPFMT">Format of
Input Data</a> for a description of the data associated with a specific format
name.</p>
</dd>
<dt><strong>Length of input data</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the input data area.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format name identifying the type of information to be changed. The
possible format names follow:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>CSVR0100</em></td>
<td align="left" valign="top">Basic server configuration</td>
</tr>
<tr>
<td align="left" valign="top"><em>CSVR0200</em></td>
<td align="left" valign="top">Add or remove suffixes from this server</td>
</tr>
<tr>
<td align="left" valign="top"><em>CSVR0300</em></td>
<td align="left" valign="top">Add, change, or remove directory indexing
rules</td>
</tr>
<tr>
<td align="left" valign="top"><em>CSVR0400</em></td>
<td align="left" valign="top">Add or change the attributes for publishing users
in an LDAP directory.</td>
</tr>
<tr>
<td align="left" valign="top"><em>CSVR0500</em></td>
<td align="left" valign="top">Add or change the network server publishing
attributes associated with the LDAP server.</td>
</tr>
<tr>
<td align="left" valign="top"><em>CSVR0600</em></td>
<td align="left" valign="top">Add or change referral server information</td>
</tr>
<tr>
<td align="left" valign="top"><em>CSVR0700</em></td>
<td align="left" valign="top">Server auditing information</td>
</tr>
<tr>
<td align="left" valign="top"><em>CSVR0800</em></td>
<td align="left" valign="top">IP address information</td>
</tr>
<!-- Begin V5R3 change -->
<tr>
<td align="left" valign="top"><em>CSVR0900</em></td>
<td valign="top">Server administration information</td>
</tr>
<!-- End V5R3 change -->
</table>
<p>See <a href="#HDRGCSPFMT">Format of Input 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="HDRGCSPFMT">Format of Input Data</a></h3>
<p>For details about the format of the input data, see the following sections.
For details about the fields in each format, see <a href="#HDRGCSPFLD">Field
Descriptions</a>.</p>
<br>
<h3>CSVR0100 Format</h3>
<p>This format is used to change 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="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%">Read only</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">Server is replica</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</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">Nonencrypted port number</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">Encrypted 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">Current cipher protocols</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">Search time limit</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">Search size limit</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">Maximum connections</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">Reserved</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">Referral port</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">Password format</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">Offset to referral server</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">Length of referral server</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">Offset to administrator DN</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">Length of administrator DN</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 administrator password</td>
</tr>
<tr>
<td align="center" valign="top">68</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of administrator password</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 update 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 update 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 password</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 password</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">Offset to key ring file</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">Length of key ring file</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">64</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Level indicator</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4">Additional fields if level indicator
is equal to 1 or greater:</td>
</tr>
<tr>
<td align="center" valign="top">108</td>
<td align="center" valign="top">68</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">Reserved</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4">Additional fields if level indicator
is equal to 2 or greater:</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">Kerberos authentication indicator</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">Offset to 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">Length of Kerberos key tab file</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">Kerberos to DN mapping indicator</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">Offset to 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">Length of Kerberos administrator ID</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">Offset to 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">Length of Kerberos administrator realm</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">Event notification registration indicator</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 connection</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 event registrations for server</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 operations per transaction</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">Maximum pending transactions</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">Transaction time limit</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">ACL model</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">Reserved</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4">Additional fields if level indicator is equal to 3 or greater:</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">Level of authority integration</td>
</tr>
<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">Offset to projected suffix</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">Length of projected suffix</td>
</tr>
<!-- Begin V5R3 change -->
<tr>
<td align="left" valign="top" colspan="4">Additional fields if level indicator is equal to 4 or greater:</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">Read only schema</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">Read only Projected suffix</td>
</tr>
<tr>
<td align="center" valign="top">228</td>
<td align="center" valign="top">E4</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">232</td>
<td align="center" valign="top">E8</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="left" valign="top" colspan="4">Variable length string fields:</td>
</tr>
<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">Administrator password</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">Update password</td>
</tr>
<tr>
<td align="center" valign="top" colspan="2"></td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Key ring file</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>CSVR0200 Format</h3>
<p>This format is used to add or remove suffixes from the server. The input
data consists of a header and a series of change entries. The header identifies
the number of suffixes to be added or removed. Each change entry identifies a
suffix and the action to be performed (add or remove the suffix).</p>
<p><strong>Note:</strong> Removing a suffix from a server will result in the
loss of all directory entries with that suffix.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Offset to change entries</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">Number of change entries</td>
</tr>
<tr>
<td align="center" valign="top" colspan="2"></td>
<td align="left" valign="top"></td>
<td align="left" valign="top">Change entries</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4">Suffix change entries:</td>
</tr>
<tr>
<td align="center" valign="top">0</td>
<td align="center" valign="top">0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to next entry</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">Action</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">Displacement to suffix</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 suffix</td>
</tr>
<tr>
<td align="center" valign="top" colspan="2"></td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Suffix</td>
</tr>
</table>
<br>
<br>
<h3>CSVR0300 Format</h3>
<p>This format is used to add, change, or remove directory indexes. Creating
indexes for one or more attributes allows for faster retrieval of directory
entries based on those attributes. The input data consists of a header and a
series of change entries. The header identifies the number of indexes to be
added, changed, or removed. Each change entry identifies an attribute and the
action to be performed (add, change, or remove the indexes).</p>
<p>Starting with V4R5M0, this format is not supported. Database index
information is to be changed using an LDAP client or the Directory Management
Tool (DMT) starting with V4R5M0.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Offset to change entries</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">Number of change entries</td>
</tr>
<tr>
<td align="center" valign="top" colspan="2"></td>
<td align="left" valign="top"></td>
<td align="left" valign="top">Change entries</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4">Add or change attribute index
entries:</td>
</tr>
<tr>
<td align="center" valign="top">0</td>
<td align="center" valign="top">0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to next entry</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">Action</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">Displacement to attribute 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 attribute 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">Index type</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">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" colspan="2"></td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Attribute name</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4">Delete attribute index entries:</td>
</tr>
<tr>
<td align="center" valign="top">0</td>
<td align="center" valign="top">0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to next entry</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">Action</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">Displacement to attribute 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 attribute 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">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" colspan="2"></td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Attribute name</td>
</tr>
</table>
<br>
<br>
<h3>CSVR0400 Format</h3>
<p>This format is used to set the attributes for publishing users in an LDAP
directory. User information from the System Distribution Directory (SDD) 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="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Offset to the server name</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of server name</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">LDAP port number</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">Connection type</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to parent distinguished name</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of parent distinguished 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">Reserved</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4">Variable length string fields:</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>CSVR0500 Format</h3>
<p>This format is used to set the network server publishing attributes
associated with the server.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Offset to change entries</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">Number of change entries</td>
</tr>
<tr>
<td align="center" valign="top" colspan="2"></td>
<td align="left" valign="top"></td>
<td align="left" valign="top">Change entries</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4">Add or change publishing agent change
entries:</td>
</tr>
<tr>
<td align="center" valign="top">0</td>
<td align="center" valign="top">0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to next entry</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">Action</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">Displacement to publishing agent 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 publishing agent 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">Displacement to server name</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of server 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">Displacement to bind DN</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 bind DN</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">Displacement to bind credentials</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">Length of bind credentials</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">LDAP port number</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">Connection type</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">Displacement to parent distinguished name</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">Length of parent distinguished name</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">Disable publishing agent</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">Level indicator</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4">Additional fields if level indicator
is equal to 1</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">Kerberos authentication indicator</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">Displacement to Kerberos key tab file</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">Length of Kerberos key tab file</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">Displacement to Kerberos principal</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">Length of Kerberos principal</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">Displacement to Kerberos realm</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">Length of Kerberos realm</td>
</tr>
<tr>
<td align="center" valign="top" colspan="2"></td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Publishing agent 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">Bind DN</td>
</tr>
<tr>
<td align="center" valign="top" colspan="2"></td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Bind credentials</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>
<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 principal</td>
</tr>
<tr>
<td align="center" valign="top" colspan="2"></td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Kerberos realm</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4">Delete publishing agent change
entries:</td>
</tr>
<tr>
<td align="center" valign="top">0</td>
<td align="center" valign="top">0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to next entry</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">Action</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">Displacement to publishing agent 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 publishing agent 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">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" colspan="2"></td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Publishing agent name</td>
</tr>
</table>
<br>
<br>
<h3>CSVR0600 Format</h3>
<p>This format is used to change referral server configuration information. The
input data consists of a header and a series of change entries. The header
identifies the master server information and the number of referral servers.
This replaces the referral server information, if any, that is currently
configured.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Offset to change entries</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">Number of change entries</td>
</tr>
<tr>
<td align="center" valign="top" colspan="2"></td>
<td align="left" valign="top"></td>
<td align="left" valign="top">Change entries</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4">Referral server change entries:</td>
</tr>
<tr>
<td align="center" valign="top">0</td>
<td align="center" valign="top">0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to next entry</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">Displacement to referral server URL</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">Length of referral 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">Referral server URL</td>
</tr>
</table>
<br>
<br>
<h3>CSVR0700 Format</h3>
<p>This format is used to change the 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="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%">Security audit option for
objects</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">Reserved</td>
</tr>
</table>
<br>
<br>
<h3>CSVR0800 Format</h3>
<p>This format is used to change the IP address configuration information. The
input data consists of a header and a series of change entries. The header
identifies the number of IP addresses in the list. This replaces the IP address
information that is currently configured. At least one IP address value must be
specified for the server.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Offset to change entries</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">Number of change entries</td>
</tr>
<tr>
<td align="center" valign="top" colspan="2"></td>
<td align="left" valign="top"></td>
<td align="left" valign="top">Change entries</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4">IP address entries:</td>
</tr>
<tr>
<td align="center" valign="top">0</td>
<td align="center" valign="top">0</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Displacement to next entry</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">Displacement to IP address</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">Length of IP address</td>
</tr>
<tr>
<td align="center" valign="top" colspan="2"></td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">IP address</td>
</tr>
</table>
<br>
<br>
<!-- Begin V5R3 change -->
<h3>CSVR0900 Format</h3>
<p>
This format is used to change the 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%">Offset to server administration URL</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of server administration URL</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">Reserved</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="HDRGCSPFLD">Field Descriptions</a></h3>
<p><strong>ACL model.</strong> Indicator of the ACL model to use. The following
special values may be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Use the ACL model that supports attribute-level
ACL permissions. This may cause compatibility problems with replication and
applications that manage access-class level permissions defined in releases
prior to V5R1M0. Once enabled, this capability can be disabled only by
reconfiguring your server and deleting the directory database.
<p>
<!-- Begin V5R3 change -->
<strong>Note:</strong> Starting with V5R3M0, this field is ignored for
format CSVR0100.
<!-- End V5R3 change -->
</p></td>
</tr>
</table>
<p><strong>Action.</strong> The action to be performed for a given entry. The
following values may be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Add suffix, index rule, or publishing agent</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Change index rule or publishing agent</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Remove suffix, index rule, or publishing
agent</td>
</tr>
</table>
<p><strong>Note:</strong> Change is valid only for the CSVR0300 and CSVR0500
formats.</p>
<p><strong>Administrator DN.</strong> A distinguished name that has access to
all objects in the directory. When either the administrator DN or the
administrator password field is changed, both must be specified. This field is
specified in UTF-16 (CCSID 13488). To leave the value unchanged, specify a
length and offset to this field of zero.</p>
<p><strong>Administrator password.</strong> The password used when connecting
to the directory server using the administrator DN. When either the
administrator DN or the administrator password field is changed, both must be
specified. This field is specified in UTF-16 (CCSID 13488). To leave the value
unchanged, specify a length and offset to this field of zero.</p>
<p><strong>Attribute index entries.</strong> The list of changes to be made to
the attribute indexes.</p>
<p><strong>Attribute name.</strong> The name of a directory object attribute
for which database indexes will be created. This field is specified in UTF-16
(CCSID 13488). The following special value may be specified:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*DEFAULT</em></td>
<td align="left" valign="top">Specifies the index types to be created for those
attributes that have no explicit rules defined.</td>
</tr>
</table>
<p><strong>Note:</strong> The *DEFAULT attribute entry may be removed or added.
Adding or removing *DEFAULT attribute is equivalent to not creating any
indexes, or creating indexes for all attributes, depending on the index types
specified.</p>
<p><strong>Bind credentials.</strong> The password used when connecting to the
directory server using the bind DN. When either the bind DN or the bind
credentials field is changed, both must be specified. This field is specified
in UTF-16 (CCSID 13488). To leave the value unchanged, specify a length and
displacement to this field of zero.</p>
<p><strong>Bind DN.</strong> A distinguished name to use when publishing
objects to the directory. When either the bind DN or the bind credentials field
is changed, both must be specified. This field is specified in UTF-16 (CCSID
13488). To leave the value unchanged, specify a length and displacement to this
field of zero.</p>
<p><strong>Change entry.</strong> A structure identifying a change to be made.
The structure identifies the suffix, attribute, or publishing agent and the
operation to be performed (add, change, or delete).</p>
<p><strong>Change log indicator.</strong> The indicator of whether to have a
change log for entries that are added, changed or deleted. The following 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">No, do not have a change log</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Yes, have a change log</td>
</tr>
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value remains the same</td>
</tr>
</table>
<p><strong>Connection type.</strong> The type of connection to use to the LDAP
server. The following values may be specified:</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>
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value remains the same</td>
</tr>
</table>
<p><strong>Current cipher protocols.</strong> The cipher protocols that the
server will allow when using encrypted connections. The following values may be
specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value remains the same</td>
</tr>
</table>
<p>Or the sum of one or more of the following values:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<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 5 (MD5) (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.)
</td>
</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 path to an existing library containing
the directory database objects. This is an integrated file system path name,
for example, /QSYS.LIB/DIRSRV.LIB. By changing this field, you make the current
directory contents inaccessible. By changing the field back to its original
value, you restore the original directory contents.
The library must exist in a
system ASP or a basic user ASP (ASP value of 1 to 32). The library cannot exist
in an independent ASP (ASP value greater than 32). This field is specified in UTF-16
(CCSID 13488). To leave the value unchanged, specify a length and offset to
this field of zero.</p>
<p><strong>Disable publishing agent.</strong> Indicates whether or not the
publishing agent is disabled. The following 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">The publishing agent is enabled.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The publishing agent is disabled.</td>
</tr>
</table>
<p><strong>Displacement to attribute name.</strong> The displacement, in bytes,
from the start of the current entry to the attribute name field.</p>
<p><strong>Displacement to bind credentials.</strong> The displacement, in
bytes, from the start of the current entry to the bind credentials field.</p>
<p><strong>Displacement to bind DN.</strong> The displacement, in bytes, from
the start of the current entry to the bind DN field.</p>
<p><strong>Displacement to IP
address.</strong> The displacement, in bytes, from the start of the current
entry to the IP address field.</p>
<p><strong>Displacement to Kerberos key tab file.</strong> The displacement, in
bytes, from the start of the current entry to the Kerberos key tab file
field.</p>
<p><strong>Displacement to Kerberos principal.</strong> The displacement, in
bytes, from the start of the current entry to the Kerberos principal field.</p>
<p><strong>Displacement to Kerberos realm.</strong> The displacement, in bytes,
from the start of the current entry to the Kerberos realm field.</p>
<p><strong>Displacement to next entry.</strong> The displacement, in bytes,
from the start of the current entry to the next entry in the input data.</p>
<p><strong>Displacement to parent distinguished name.</strong> The
displacement, in bytes, from the start of the current entry to the parent
distinguished name field.</p>
<p><strong>Displacement to publishing agent name.</strong> The displacement, in
bytes, from the start of the current entry to the publishing agent name
field.</p>
<p><strong>Displacement to referral server URL.</strong> The displacement, in
bytes, from the start of the current entry to the referral server URL
field.</p>
<p><strong>Displacement to server name.</strong> The displacement, in bytes,
from the start of the current entry to the server name field.</p>
<p><strong>Displacement to suffix.</strong> The displacement, in bytes, from
the start of the current entry to the suffix field.</p>
<p><strong>Encrypted port number.</strong> The port number to use for encrypted
connections. The standard port number for encrypted connections (SSL) is 636.
Valid port numbers are in the range 1 to 65535. The following special value may
be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
</table>
<p><strong>Event notification registration indicator.</strong> Indicator of
whether to allow client to register for event notification. The following
special values may be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<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>Index type.</strong> The kind of database indexes that will be
created for an attribute. Creating database indexes improved the performance of
directory searches on those attributes. The following 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">No indexes will be maintained for the specified
attribute</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Equal</td>
</tr>
</table>
<p><strong>Note:</strong> For a delete request, 0 must be specified for this
field.</p>
<!-- The IPv4 wording comes from qwtchgjb.htm.-->
<p><strong>IP address.</strong>
The IPv4 or IPv6 address of the client for which the directory server will accept connections.
The IP address must already exist to be specified. A value of hexadecimal zeroes and leading
zeroes is not allowed. An IPv4
address is expressed in standard dotted-decimal form www.xxx.yyy.zzz; for
example, 130.99.128.1. An IPv6 address always has at least one occurrence of a colon (':') in
the format. Some possible IPv6 address formats would be: ::x (for example, ::1) or
::w.xxx.y.zzz (for example, ::9.130.4.169). For further IPv6 examples and explanation, refer
to the Usage Notes section in the Convert IPv4 and IPv6 Addresses Between Text and Binary
Form (inet_pton) API. This field is specified in UTF-16 (CCSID 13488).</p>
<p>The following special value may be specified:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All IP addresses defined on the local system will
be bound to the server.</td>
</tr>
</table>
<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 specified:</p>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*NONE</em></td>
<td align="left" valign="top">No value is specified.</td>
</tr>
</table>
<p>To leave the value unchanged, specify a length and offset to this field of
zero.</p>
<p><strong>Kerberos administrator realm.</strong> The realm where the kerberos
administrator is registered. This field is specified in UTF-16 (CCSID 13488).
The following special value may be specified:</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>To leave the value unchanged, specify a length and offset to this field of
zero.</p>
<p><strong>Kerberos authentication indicator.</strong> The following special
values may be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<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. Ensure all
Kerberos fields are specified.</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. The QDIRSRV user profile is given authorization to read this
file. This field is specified in UTF-16 (CCSID 13488). The following special
value may be specified:</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>To leave the value unchanged, specify a length and offset or displacement to
this field of zero.</p>
<p><strong>Kerberos principal.</strong> The principal in the key tab file to
use for authentication. This field is specified in UTF-16 (CCSID 13488). The
following special value may be specified:</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>To leave the value unchanged, specify a length and offset or displacement to
this field of zero.</p>
<p><strong>Kerberos realm.</strong> The realm where the principal is registered
to use for authentication. This field is specified in UTF-16 (CCSID 13488). The
following special value may be specified:</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>To leave the value unchanged, specify a length and offset or displacement to
this field of zero.</p>
<p><strong>Kerberos to DN mapping indicator.</strong></p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<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>Key ring file.</strong> The path name of the SSL key ring file. A
key ring file must be configured when using SSL. The following special value
may be specified:</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>Note:</strong> Starting with V4R4M0, this field is ignored for
format CSVR0100. This field is specified in UTF-16 (CCSID 13488).</p>
<p>To leave the value unchanged, specify a length and offset to this field of
zero.</p>
<p><strong>LDAP port number.</strong> The LDAP server's TCP/IP port. The
following values may be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value remains the same</td>
</tr>
</table>
<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 administrator password.</strong> The length, in UTF-16 (CCSID 13488)
characters, of the administrator password field.</p>
<p><strong>Length of attribute name.</strong> The length, in UTF-16 (CCSID 13488)
characters, of the the attribute name field.</p>
<p><strong>Length of bind credentials.</strong> The length, in UTF-16 (CCSID 13488)
characters, of the bind credentials field.</p>
<p><strong>Length of bind DN.</strong> The length, in UTF-16 (CCSID 13488) characters, of
the bind 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 IP
address.</strong> The length, in UTF-16 (CCSID 13488) characters, of the IP address
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 Kerberos principal.</strong> The length, in UTF-16 (CCSID 13488)
characters, of the Kerberos principal field.</p>
<p><strong>Length of Kerberos realm.</strong> The length, in UTF-16 (CCSID 13488)
characters, of the Kerberos realm field.</p>
<p><strong>Length of key ring file.</strong> The length, in UTF-16 (CCSID 13488) characters,
of the key ring 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>
<p><strong>Length of publishing agent name.</strong> The length, in UTF-16 (CCSID 13488)
characters, of the publishing agent name. The length can be at most 50 characters.</p>
<p><strong>Length of referral server.</strong> The length, in UTF-16 (CCSID 13488)
characters, of the referral server name.</p>
<p><strong>Length of referral server URL.</strong> The length, in UTF-16 (CCSID 13488)
characters, of the referral server URL 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 suffix.</strong> The length, in UTF-16 (CCSID 13488) characters, of the
suffix 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>Length of update password.</strong> The length, in UTF-16 (CCSID 13488)
characters, of the update password field.</p>
<p><strong>Level indicator.</strong> The level indicator of the data supplied
for a format. See the format descriptions for possible uses and values of this
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.
Allowing a user profile to become an LDAP administrator can be done by setting
the 'Level of authority integration' to '1' and then authorizing specific user
profiles to the 'Directory Server Administrator' function of the operating
system through iSeries Navigator's Application support. The Change Function
Usage Information (QSYCHFUI) API, with a function ID of QIBM_DIRSRV_ADMIN, can
also be used to change the list of users that are allowed to be an LDAP
administator. The user profile can be mapped to a DN as a projected user (for
example, for user profile 'FRED', and the projected suffix of 'systemA', the
projected user's DN would be os400-profile=FRED,cn=accounts,os400-sys=systemA
).</p>
<p>The following special values may be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Do not apply 'Directory Server Administrator'
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' 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 specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<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 specified:</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>To leave the value unchanged, specify a length and offset to this field of
zero.</p>
<p><strong>Maximum connections.</strong> The maximum number of simultaneous
connections that can be established with the server. The following special
values may be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<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>Note:</strong> Starting with V5R1M0, this field is no longer
supported and is ignored if a value is passed.</p>
<p><strong>Maximum event registrations for connection.</strong> The following
special values may be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<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 specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<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 maximum 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
used if 'Change log indicator' is set to 1. The following special values may be
specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Do not limit the age of change log
entries.</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
used if 'Change log indicator' is set to 1. The following special values may be
specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Do not limit the number of change log
entries.</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. The following
special values may be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
</table>
<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. The following special value may be
specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
</table>
<p><strong>Nonencrypted port number.</strong> The port number to be used for
nonencrypted connections. The standard port number is 389. Valid port numbers
are in the range 1 to 65535. The following special value may be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
</table>
<p><strong>Number of change entries.</strong> The number of change entries
present in the input data.</p>
<p><strong>Number of database connections.</strong> The number of database
connections used by the server. Valid numbers are in the range 4 to 32. The
following special value may be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
</table>
<p><strong>Offset to administrator DN.</strong> The offset, in bytes, from the
start of the input data area to the administrator DN field.</p>
<p><strong>Offset to administrator password.</strong> The offset, in bytes,
from the start of the input data area to the administrator password field.</p>
<p><strong>Offset to change entries.</strong> The offset, in bytes, from the
start of the input data area to the the first change entry.</p>
<p><strong>Offset to database path.</strong> The offset, in bytes, from the
start of the input data area 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 key ring file.</strong> The offset, in bytes, from the
start of the input data area to the key ring file field.</p>
<p><strong>Offset to master server URL.</strong> The offset, in bytes, from the
start of the input data area to the master server URL field.</p>
<p><strong>Offset to parent distinguished name.</strong> The offset, in bytes,
from the start of the input data area 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 input data area 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 input data 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 input data to the server name field.</p>
<p><strong>Offset to suffix.</strong> The offset, in bytes, from the start of
the input data area to the suffix field.</p>
<p><strong>Offset to update DN.</strong> The offset, in bytes, from the start
of the input data area to the update DN field.</p>
<p><strong>Offset to update password.</strong> The offset, in bytes, from the
start of the input data area to the update password 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). To leave the value unchanged, specify a length and offset
to this field of zero.</p>
<p><strong>Password format.</strong> The format of the encrypted password. The
following values may be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<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>Publishing agent name.</strong> The agent that will publish
information to a directory server and parent distinguished name. This field is
specified in UTF-16 (CCSID 13488).</p>
<p>The following publishing agent names are predefined by the operating system:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>*AS400_COMPUTERS</em></td>
<td align="left" valign="top">This agent name is used for publishing system information such as the system and printers.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*AS400_PRINTSHARES</em></td>
<td align="left" valign="top">This agent name is used for publishing print shares to an Active Directory server.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*AS400_USERS</em></td>
<td align="left" valign="top">This agent name is used for publishing System Distribution Directory users.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*OS400_TC1_QOS</em></td>
<td align="left" valign="top">This agent name is used for publishing TCP/IP Quality of Service policy information.</td>
</tr>
</table>
<p><strong>Read only.</strong> Whether the directory server will allow updates
to be made to the directory contents. The following values may be
specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Places the directory server into update mode to
allow directory updates. This is the normal mode of operation.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Places the directory server into read-only
mode.</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 specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Places the directory server projected suffix into update mode to allow updates. This is the normal mode of operation.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Places the directory server projected suffix into read-only mode.</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 specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Places the directory server schema into update mode to allow updates. This is the normal mode of operation.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Places the directory server schema into read-only mode.</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 referral server and port fields must be configured when
changing the Server is replica field to make this server a replica. Valid port
numbers are in the range 1 to 65535.</p>
<p>Starting with V4R5M0, this field is ignored for format CSVR0100. Referral
server information can be changed using the CSVR0600 format of the
QgldChgDirSvrA API. 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">No port number is returned as part of the
referral.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
</table>
<p><strong>Referral server.</strong> The IP name or address of a server to
return 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 are used together
to form a referral URL. The referral server and port fields must be configured
when changing the Server is a replica field to make this server a replica. In
this case, the referral is typically to the master server. The following
special value may be specified:</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>Note:</strong> Starting with V4R5M0, this field is ignored for
format CSVR0100. This field is specified in UTF-16 (CCSID 13488). To leave the
value unchanged, specify a length and offset to this field of zero.</p>
<p><strong>Referral server URL.</strong> The uniform resource locator (URL) of
the referral server. This field is specified in UTF-16 (CCSID 13488).</p>
<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 specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value does not change.</td>
</tr>
<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 values may
be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<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
values may be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<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 should use encrypted
connections. The following values may be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value does not change</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Allow nonencrypted connections only</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Allow encrypted connections only</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">Allow both encrypted and nonencrypted
connections</td>
</tr>
</table>
<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 specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<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. When this field is changed to make the server a replica, the
update DN, update password, and referral fields must be specified. The
following values may be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The server is a master 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). To leave the value unchanged, specify a
length and offset to this field of zero.
</p>
<!-- End V5R3 change -->
<p><strong>Server name.</strong> The name of the server. This field is
specified in UTF-16 (CCSID 13488). To leave the value unchanged, specify a
length and offset to this field of zero.</p>
<p><strong>SSL authentication method.</strong> The method used during SSL
authentication. The following values may be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value does not change.</td>
</tr>
<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>Suffix.</strong> The name of the directory suffix to be added or
removed from the server. This field is specified in UTF-16 (CCSID 13488).</p>
<p><strong>Suffix change entries.</strong> The list of suffixes to be added or
deleted.</p>
<p><strong>Terminate idle connections.</strong> The server will terminate idle
connections when necessary.</p>
<p>Starting with V5R1M0, this field is no longer supported and is ignored if a
value is passed. The following 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 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>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. The
following special values may be specified:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>-1</em></td>
<td align="left" valign="top">The value of this field does not change.</td>
</tr>
</table>
<p><strong>Update DN.</strong> The distinguished name that the master server
must use when propagating directory updates to this replica server. This field
may be specified only when the server is a replica. When either the update DN
or the update password field is changed, both must be specified. This field is
specified in UTF-16 (CCSID 13488). The following special value may be
specified:</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>To leave the value unchanged, specify a length and offset to this field of
zero.</p>
<p><strong>Update password.</strong> The password used when connecting to this
server using the update DN. This field may be specified only when the server is
a replica. When either the update DN or the update password field is changed,
both must be specified. This field is specified in UTF-16 (CCSID 13488). To
leave the value unchanged, specify a length and offset to this field of zero.
The following special value may be specified:</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>
<br>
<br>
<h3>Error Messages</h3>
<table width="100%" 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">CPF2209 E</td>
<td align="left" valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPFA0A9 E</td>
<td align="left" valign="top">Object not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPFA0DB E</td>
<td align="left" valign="top">Object name not a QSYS object.</td>
</tr>
<tr>
<td align="left" valign="top">CPFA314 E</td>
<td align="left" valign="top">Memory allocation error.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0204 E</td>
<td align="left" valign="top">Attribute name not valid.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0205 E</td>
<td align="left" valign="top">Administrator DN not valid.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0208 E</td>
<td align="left" valign="top">Key ring file name not valid.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0209 E</td>
<td align="left" valign="top">Update DN not valid.</td>
</tr>
<tr>
<td align="left" valign="top">GLD020A E</td>
<td align="left" valign="top">Suffix not valid.</td>
</tr>
<tr>
<td align="left" valign="top">GLD020B E</td>
<td align="left" valign="top">Referral server name not valid.</td>
</tr>
<tr>
<td align="left" valign="top">GLD020D E</td>
<td align="left" valign="top">Index rule already defined for attribute.</td>
</tr>
<tr>
<td align="left" valign="top">GLD020E E</td>
<td align="left" valign="top">Index rule not found for attribute.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0211 E</td>
<td align="left" valign="top">Value &amp;1 specified at offset &amp;2 in input
format &amp;3 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0212 E</td>
<td align="left" valign="top">Field &amp;1 required when server is using
SSL.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0215 E</td>
<td align="left" valign="top">IBM Directory Server for iSeries server has not been
configured.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0217 E</td>
<td align="left" valign="top">A value was specified in list entry &amp;1 that
is not valid. Reason code &amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0219 E</td>
<td align="left" valign="top">Administrator DN and password both required.</td>
</tr>
<tr>
<td align="left" valign="top">GLD021A E</td>
<td align="left" valign="top">Field not allowed when server is not a
replica.</td>
</tr>
<tr>
<td align="left" valign="top">GLD021B E</td>
<td align="left" valign="top">Field is required when server is a replica.</td>
</tr>
<tr>
<td align="left" valign="top">GLD021C E</td>
<td align="left" valign="top">The caller of the API must have *ALLOBJ and
*IOSYSCFG special authority to configure the server.</td>
</tr>
<tr>
<td align="left" valign="top">GLD021D E</td>
<td align="left" valign="top">Error occurred when processing the input list of
entries.</td>
</tr>
<tr>
<td align="left" valign="top">GLD021E E</td>
<td align="left" valign="top">&amp;1 password is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">GLD021F E</td>
<td align="left" valign="top">The caller of the API must have *AUDIT special
authority to set the server auditing information.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0221 E</td>
<td align="left" valign="top">Offset &amp;1 specified in input data is not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0222 E</td>
<td align="left" valign="top">Length &amp;1 specified in input data is not
valid.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0223 E</td>
<td align="left" valign="top">Database path not valid.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0227 E</td>
<td align="left" valign="top">Distinguished names cannot be modified while the
server is active.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0229 E</td>
<td align="left" valign="top">Validation list not found.</td>
</tr>
<tr>
<td align="left" valign="top">GLD022D E</td>
<td align="left" valign="top">Publishing &amp;1 agent not found.</td>
</tr>
<tr>
<td align="left" valign="top">GLD022E E</td>
<td align="left" valign="top">Publishing agent &amp;1 is already
configured.</td>
</tr>
<tr>
<td align="left" valign="top">GLD022F E</td>
<td align="left" valign="top">Format not supported.</td>
</tr>
<tr>
<td align="left" valign="top">
GLD0231 E</td>
<td align="left" valign="top">Cannot set the password for a projected
user.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0232 E</td>
<td align="left" valign="top">Configuration contains overlapping suffixes.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0233 E</td>
<td align="left" valign="top">Cannot set database library to
/QSYS.LIB/QUSRDIRCL.LIB.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0235 E</td>
<td align="left" valign="top">IP address is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0236 E</td>
<td align="left" valign="top">Database library must be in system ASP or basic
user ASP.</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>
Reference in New Issue View Git Blame Copy Permalink