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

982 lines
28 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<!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>List Directory Server Attributes (QgldLstDirSvrA)</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>List Directory Server Attributes (QgldLstDirSvrA)</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%">Qualified user space name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">2</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">3</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 List Directory Server Attributes (QgldLstDirSvrA) API retrieves a list
of directory server attributes including the following:</p>
<ul>
<li>Suffixes present on the server</li>
<li>Attribute indexes maintained by the underlying database</li>
<li>Network server publishing attributes associated with the LDAP server.</li>
<li>IP address information</li>
</ul>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>User Space Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>User Space Authority</em></dt>
<dd>*CHANGE</dd>
<dt><em>User Space Lock</em></dt>
<dd>An exclusive, no-read lock is obtained on the list space.</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Qualified user space name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The user space that is to receive the created list. The first 10 characters
contain the user space name, and the second 10 characters contain the name of
the library where the user space is located. The content and format of this
space is determined by the format name. See <a href="#HDRGLSPFMT">Format of
Output Data</a> for a description of these formats.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The content and format of the data to be retrieved. The possible format
names follow:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>LSVR0200</em></td>
<td align="left" valign="top">Retrieve a list of suffixes on the server.</td>
</tr>
<tr>
<td align="left" valign="top"><em>LSVR0300</em></td>
<td align="left" valign="top">Retrieve a list of database indexes maintained by
the server.</td>
</tr>
<tr>
<td align="left" valign="top"><em>LSVR0500</em></td>
<td align="left" valign="top">Retrieve a list of network server publishing
attributes associated with the LDAP server.</td>
</tr>
<tr>
<td align="left" valign="top"><em>LSVR0600</em></td>
<td align="left" valign="top">Retrieve a list of referral servers.</td>
</tr>
<tr>
<td align="left" valign="top"><em>LSVR0800</em></td>
<td align="left" valign="top">Retrieve a list of IP addresses</td>
</tr>
<!-- End V5R2 change --></table>
<p>See <a href="#HDRGLSPFMT">Format of Output Data</a> for a description of
these formats.</p>
</dd>
<dt><strong>Error code</strong></dt>
<dd>I/O; CHAR(*)
<p>The structure in which to return error information. For the format of the
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
</dd>
</dl>
<br>
<h3><a name="HDRGLSPFMT">Format of Output Data</a></h3>
<p>The user space contains:</p>
<ul>
<li>A user area</li>
<li>A generic area</li>
<li>An input parameter section</li>
<li>A header section</li>
<li>A list data section:
<ul>
<li>LSVR0200</li>
<li>LSVR0300</li>
<li>LSVR0500</li>
<li>LSVR0600</li>
<li>LSVR0800</li>
<!-- End V5R2 change --></ul>
</li>
</ul>
<p>For details about the user area and generic header, see <a href="../apiref/usf.htm">
User Space Format for List APIs</a>. For details about the remaining items, see
the following sections. For detailed descriptions of the fields in the list
that is returned, see <a href="#HDRGLSPFLD">Field Descriptions</a>.</p>
<p>When you retrieve list entry information from the list space, do not use the
entry size that is returned in the generic header. Instead, use the
displacement to next entry field that is returned in each list entry. If you do
not use the displacement to next entry field, the results may not be valid.</p>
<br>
<h3>LSVR0200 Format</h3>
<p>The LSVR0200 format is used to retrieve a list of the directory suffixes
present on this 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%">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 suffix</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</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">Reserved</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>LSVR0300 Format</h3>
<p>The LSVR0300 format is used to retrieve information about database indexes
maintained by the server. The indexes are used to speed up retrieval of objects
when a directory server client searches for specified object attributes.</p>
<p>Starting with V4R5M0, this format is not supported. Database index
information is to be retrieved 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%">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 attribute 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 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">Index 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">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>LSVR0500 Format</h3>
<p>The LSVR0500 format is used to retrieve 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%">Displacement to next entry</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 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">LDAP port number</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">Connection type</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">Displacement to parent distinguished name</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">Length of parent distinguished name</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">Publishing agent disabled</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">56</td>
<td align="center" valign="top">38</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Kerberos authentication indicator</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">Displacement to Kerberos key tab file</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">Length of Kerberos key tab file</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 principal</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 principal</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 realm</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 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">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>
</table>
<br>
<br>
<h3>LSVR0600 Format</h3>
<p>The LSVR0600 format is used to retrieve a list of referral servers.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Displacement to next 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">12</td>
<td align="center" valign="top">C</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">Referral server URL.</td>
</tr>
</table>
<br>
<br>
<!-- Begin V5R2 change -->
<h3>LSVR0800 Format</h3>
<p>The LSVR0800 format is used to retrieve a list of the IP addresses to which
the directory server connects.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="bottom">Dec</th>
<th align="center" valign="bottom">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">0</td>
<td align="left" valign="top" width="20%">BINARY(4)</td>
<td align="left" valign="top" width="60%">Displacement to next 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>
<!-- End V5R2 change --><br>
<br>
<h3><a name="HDRGLSPFLD">Field Descriptions</a></h3>
<p><strong>Attribute name.</strong> The name of a directory object attribute
for which database indexes will be maintained. This field is specified in UTF-16
(CCSID 13488). The following special value may also be returned:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*DEFAULT</em></td>
<td align="left" valign="top">The rules for this attribute apply to all
attributes for which no explicit rules have been defined.</td>
</tr>
</table>
<p><strong>Bind DN.</strong> A distinguished name to use when publishing
objects to the directory.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><strong>Connection type.</strong> The type of connection to use to the LDAP
server. The following values may be returned:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Nonsecure</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Secured, using SSL</td>
</tr>
</table>
<p><strong>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 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>
<!-- End V5R2 change -->
<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.</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.</p>
<p><strong>Format name specified.</strong> The format name specified on the
call to this API.</p>
<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
returned:</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 created for the
attribute.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Equal</td>
</tr>
</table>
<!-- Begin V5R2 change -->
<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>The following special value may be returned:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<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>
<!-- End V5R2 change -->
<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>0</em></td>
<td align="left" valign="top">Do not support Kerberos authentications.</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Support Kerberos authentications.</td>
</tr>
</table>
<p><strong>Kerberos key tab file.</strong> The integrated file system path name
for the key tab file that contains the server's secret key used for
authentication. 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><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><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><strong>LDAP port number.</strong> The LDAP server's TCP/IP port.</p>
<p><strong>Length of attribute name.</strong> The length, in UTF-16 (CCSID 13488)
characters, of the attribute name field.</p>
<p><strong>Length of bind DN.</strong> The length, in UTF-16 (CCSID 13488) characters, of
the bind DN field.</p>
<!-- Begin V5R2 change -->
<p><strong>Length of IP
address.</strong> The length, in UTF-16 (CCSID 13488) characters, of the IP address
field.</p>
<!-- End V5R2 change -->
<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 parent distinguished name.</strong> The length, in UTF-16 (CCSID 13488)
characters, of the parent distinguished name field.</p>
<p><strong>Length of publishing agent name.</strong> The length, in UTF-16 (CCSID 13488)
characters, of the publishing agent name field.</p>
<p><strong>Length of referral server URL.</strong> The length, in UTF-16 (CCSID 13488)
characters, of the referral server URL field.</p>
<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>Parent distinguished name.</strong> The parent distinguished name to
be used. This field is specified in UTF-16 (CCSID 13488).</p>
<p><strong>Publishing agent name.</strong> The agent which 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>Publishing agent disabled.</strong> Indicates whether or not the
publishing agent is disabled. The configuration data still exists, but
publishing has been disabled for the publishing agent. The following values may
be returned:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The 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>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>Server name.</strong> The name of the server. This field is
specified in UTF-16 (CCSID 13488).</p>
<p><strong>Suffix.</strong> The directory name for the starting point of a
directory information tree.This field is specified in UTF-16 (CCSID 13488).</p>
<br>
<h3>Error Messages</h3>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top" nowrap>Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td align="left" valign="top">Severe error while addressing parameter
list.</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">GLD022F E</td>
<td align="left" valign="top">Format not supported.</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 Copy Permalink