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

491 lines
14 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Import LDIF File (QgldImportLdif)</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>Import LDIF File (QgldImportLdif)</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 Import LDIF File (QgldImportLdif) API imports directory server data from
a Lightweight Directory Access Protocol Data Interchange Format (LDIF)
file.</p>
<p>The IBM Directory Server must be stopped to use this API. To stop the
server, use the End TCP/IP Server (ENDTCPSVR SVR(*DIRSRV)) command.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Directory Authority</em></dt>
<dd>The caller must provide the administrator DN and password if the caller
does not have *ALLOBJ and *IOSYSCFG special authorities
and
the caller is not a IBM Directory Server administrator. The caller is a IBM Directory
Server administrator if the IBM Directory Server for iSeries has been configured to
grant administrator access to authorized users and the caller is authorized to the
'Directory Server Administrator' function of the operating system.<br><br></dd>
<dt><em>Object Authorities</em></dt>
<dd>The caller must have Execute (*X) authority to each directory in the path
name preceding the name of the LDIF file. The caller must have Read (*R)
authority to the LDIF file.</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Input data</strong></dt>
<dd>INPUT; CHAR(*)
<p>Input data required to identify the LDIF file and the administrator name and
password. The content and format of this structure are determined by the format
name. See <a href="#HDRGLDIFMT">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 data. The possible format name
follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>LDIF0100</em></td>
<td align="left" valign="top">Import LDIF file</td>
</tr>
<!-- Begin V5R3 change -->
<tr>
<td align="left" valign="top"><em>LDIF0200</em></td>
<td valign="top">Import LDIF file with options</td>
</tr>
<!-- End V5R3 change -->
</table>
<p>See <a href="#HDRGLDIFMT">Format of Input Data</a> for a description of
this format.</p>
</dd>
<dt><strong>Error code</strong></dt>
<dd><br>
</dd>
<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="HDRGLDIFMT">Format of Input Data</a></h3>
<p>For details about the format of the input data, see the following section.
For details about the fields in each format, see <a href="#HDRGLDIFLD">Field
Descriptions</a>.</p>
<br>
<h3>LDIF0100 Format</h3>
<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 LDIF file</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 LDIF file</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 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" colspan="2"></td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">LDIF file</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>
</table>
<br>
<br>
<!-- Begin V5R3 change -->
<h3>LDIF0200 Format</h3>
<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 LDIF file</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 LDIF file</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 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">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">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Replicate imported data</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">LDIF file</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>
</table>
<!-- End V5R3 change -->
<br>
<br>
<h3><a name="HDRGLDIFLD">Field Descriptions</a></h3>
<!-- Begin V5R3 change -->
<p><strong>Additional fields indicator.</strong> Additional fields supplied for a format.
See the format descriptions for possible uses and values of this field.</p>
<!-- End V5R3 change -->
<p><strong>Administrator DN.</strong> The distinguished name of the server
administrator. This field is specified in UTF-16 (CCSID 13488).</p>
<p><strong>Administrator password.</strong> The password for the server
administrator. This field is specified in UTF-16 (CCSID 13488).</p>
<p><strong>LDIF file.</strong> The integrated file system path name of the LDIF
file to be used. This field is specified in UTF-16 (CCSID 13488).</p>
<p><strong>Length of administrator DN.</strong> The length, in UTF-16 (CCSID 13488)
characters, of the administrator DN field.</p>
<p><strong>Length of administrator password.</strong> The length, in UTF-16 (CCSID 13488)
characters, of the administrator password field.</p>
<p><strong>Length of LDIF file.</strong> The length, in UTF-16 (CCSID 13488) characters, of
the LDIF file field.</p>
<!-- Begin V5R3 change -->
<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>
<!-- End V5R3 change -->
<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 LDIF file.</strong> The offset, in bytes, from the start
of the input data to the LDIF file field.</p>
<!-- Begin V5R3 change -->
<p>
<strong> Replicate imported data.</strong> Indicates whether imported data should be replicated to replica servers. This option could be used, for example, when initializing an additional master server so that it does not attempt to replicate data to servers already containing this data. If format LDIF0100 is used, imported data is replicated. The following values may be specified Whether the directory server will replicate imported data. 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">Imported data is not replicated.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Imported data is replicated. The value 1 can only be specified if a subtree DN is specified.</td>
</tr>
</table>
<!-- End V5R3 change -->
<br>
<h3>Error Messages</h3>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top" nowrap>Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">GLD0125 E</td>
<td align="left" valign="top">IBM Directory Server failed for reason code
&amp;4.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0202 E</td>
<td align="left" valign="top">Administrator DN or password not correct.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0213 E</td>
<td align="left" valign="top">Error opening or creating file.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0215 E</td>
<td align="left" valign="top">Server has not been configured.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0218 E</td>
<td align="left" valign="top">*ALLOBJ and *IOSYSCFG special authorities
required.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0225 E</td>
<td align="left" valign="top">&amp;1 items added to directory, &amp;2 items not
added.</td>
</tr>
<tr>
<td align="left" valign="top">GLD0226 E</td>
<td align="left" valign="top">LDAP server is read-only.</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