432 lines
12 KiB
HTML
432 lines
12 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
|
<title>Configure Directory Server (QgldCfgDirSvr)</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>Configure Directory Server (QgldCfgDirSvr)</h2>
|
|
|
|
<div class="box" style="width: 65%;">
|
|
<br>
|
|
Required Parameter Group:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">1</td>
|
|
<td align="left" valign="top" width="50%">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>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Library Name/Service Program: QSYS/QGLDUAPI<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Configure Directory Server (QgldCfgDirSvr) API creates the initial
|
|
directory server configuration. This includes identifying the library that will
|
|
contain the underlying database objects, the administrator of the server, and
|
|
the initial set of suffixes to be present on the server.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<p>*ALLOBJ and *IOSYSCFG special authority is required to use this API.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Input data</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>Data that describes the desired directory server configuration. The content
|
|
and format of this structure are determined by the format name. See <a href=
|
|
"#HDRGLDCFMT">Format of Input Data</a> for a description of these formats.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of input data</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the input data structure.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The content and format of the input configuration data. The possible format
|
|
name follows:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>CFGD0100</em></td>
|
|
<td align="left" valign="top">Configure Directory Server.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>See <a href="#HDRGLDCFMT">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="HDRGLDCFMT">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="#HDRGLDCFLD">Field
|
|
Descriptions</a>.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>CFGD0100 Format</h3>
|
|
|
|
<p>This format is used to provide initial configuration data about the
|
|
directory 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="50%">Offset to database path</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 database path</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to administrator distinguished name
|
|
(DN)</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 administrator DN</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 administrator password</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of administrator password</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">24</td>
|
|
<td align="center" valign="top">18</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to suffixes</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">Number of suffixes</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">Reserved</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">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="left" valign="top" colspan="4">Suffixes:</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 suffix</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 suffix 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">Length of suffix name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" colspan="2"></td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">Suffix name</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRGLDCFLD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Administrator DN.</strong> The distinguished name of a directory
|
|
object that has access to all objects in the directory. This field is specified
|
|
in UTF-16 (CCSID 13488).</p>
|
|
|
|
<p><strong>Administrator password.</strong> The password used when you connect
|
|
to the directory as the administrator. This field is specified in UTF-16 (CCSID
|
|
13488).</p>
|
|
|
|
<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/QDIRSRV.LIB. 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).</p>
|
|
|
|
<p><strong>Displacement to next suffix.</strong> The displacement, in bytes,
|
|
from the start of the current suffix entry to the next suffix entry.</p>
|
|
|
|
<p><strong>Displacement to suffix name.</strong> The displacement, in bytes,
|
|
from the start of the current suffix entry to the suffix name field.</p>
|
|
|
|
<p><strong>Length of administrator DN.</strong> The length, in UTF-16 (CCSID 13488)
|
|
characters, of the administrator DN</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 database path.</strong> The length, in UTF-16 (CCSID 13488) characters,
|
|
of the database path field.</p>
|
|
|
|
<p><strong>Length of suffix name.</strong> The length, in UTF-16 (CCSID 13488) characters,
|
|
of the suffix name field.</p>
|
|
|
|
<p><strong>Number of suffixes.</strong> The number of suffixes present in the
|
|
suffix list.</p>
|
|
|
|
<p><strong>Offset to administrator DN.</strong> The offset, in bytes, from the
|
|
start of the input data to the administrator DN field.</p>
|
|
|
|
<p><strong>Offset to administrator password.</strong> The offset, in bytes,
|
|
from the start of the input data to the administrator password field.</p>
|
|
|
|
<p><strong>Offset to database path.</strong> The offset, in bytes, from the
|
|
start of the input data to the database path field.</p>
|
|
|
|
<p><strong>Offset to suffixes.</strong> The offset, in bytes, from the start of
|
|
the input data to the list of suffixes.</p>
|
|
|
|
<p><strong>Reserved.</strong> A reserved field. This field must be set to
|
|
zero.</p>
|
|
|
|
<p><strong>Suffixes.</strong> The list of suffixes to be present on the server.
|
|
At least one must be present in the initial configuration.</p>
|
|
|
|
<p><strong>Suffix name.</strong> The distinguished name of the root of a
|
|
directory tree present on the server.This field is specified in UTF-16 (CCSID
|
|
13488).</p>
|
|
|
|
<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 &1 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">GLD0205 E</td>
|
|
<td align="left" valign="top">Administrator 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">GLD021C E</td>
|
|
<td align="left" valign="top">*ALLOBJ and *IOSYSCFG special authority
|
|
required.</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">GLD0228 E</td>
|
|
<td align="left" valign="top">Validation list not created.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">GLD022A E</td>
|
|
<td align="left" valign="top">Server configuration cannot be modified while the
|
|
server is active.</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>
|
|
|