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/eimsetconfigurationext.htm

658 lines
20 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>eimSetConfigurationExt()--Set EIM Configuration Extended</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. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- New for V5R3 by Barb Smith -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!--Java sync-link-->
<script type="text/javascript" language="javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2>
eimSetConfigurationExt()--Set EIM Configuration Extended</h2>
<!-- ============================================================== -->
<!-- -->
<!-- S Y N T A X / P A R M T A B L E -->
<!-- -->
<!-- ============================================================== -->
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;Syntax
<pre>
#include &lt;eim.h&gt;
int eimSetConfigurationExt(EimConfigInfo * <em>configInfo</em>,
EimRC * <em>eimrc</em>)
</pre>
&nbsp;&nbsp;Service Program Name: QSYS/QSYEIM<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<!-- ============================================================== -->
<!-- -->
<!-- D E S C R I P T I O N -->
<!-- -->
<!-- ============================================================== -->
<p>The <strong>eimSetConfigurationExt()</strong> function sets the
configuration information for use by the system.</p>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- A U T H O R I T I E S A N D L O C K S -->
<!-- -->
<!-- ============================================================== -->
<h3>Authorities and Locks</h3>
<p>The caller of the API must have *SECADM special authority.</p>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- P A R A M E T E R S -->
<!-- -->
<!-- ============================================================== -->
<h3>Parameters</h3>
<dl><!-- ============================================================== -->
<!-- configInfo -->
<!-- ============================================================== -->
<dt><strong>configInfo</strong>&nbsp;&nbsp;(Input)</dt>
<dd>The configuration information to be set.
<p>The EimConfigInfo structure contains the configuration information.</p>
<p>For EIM_CONFIG_FORMAT_0 (0) configuration format, the <em>config</em> field
must contain an EimConfigFormat0 structure.</p>
<p>The structure layouts follow:</p>
<pre>
enum EimConfigFormat {
EIM_CONFIG_FORMAT_0 /* Information is in configuration
format 0. */
};
typedef struct EimConfigFormat0
{
char * ldapURL; /* URL for EIM domain controller. */
char * localRegistry; /* Local system registry name. */
char * kerberosRegistry; /* Kerberos registry name. */
char * x509Registry; /* X.509 registry name. */
} EimConfigFormat0;
typedef struct EimConfigInfo
{
enum EimConfigFormat format; /* Format of the config info. */
int enable; /* Indicate if able to establish
new connections in order to
participate in EIM domain
0 = not enabled
1 = enabled */
int ccsid; /* CCSID of input data. If 0 or
65535, default job CCSID will
be used. */
union {
EimConfigFormat0 format0;
} config; /* Configuration information */
} EimConfigInfo;
</pre>
<p>Detail description for the configuration information:</p>
<ul>
<li><em>ldapURL</em>
<dl>
<dd>A uniform resource locator (URL) that contains the EIM configuration
information for the EIM domain controller. This information will be used for
all EIM operations. The maximum size for this URL is 1000 bytes.</dd>
<dd>
<p>Possible values are:</p>
<table cellpadding="3">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>NULL</em></td>
<td align="left" valign="top">A value of NULL indicates that it should not
change.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>EIM_CONFIG_NONE</em></td>
<td align="left" valign="top">(*NONE) This value indicates that this system is
not configured for EIM.</td>
</tr>
<tr>
<td align="left" valign="top"><em>ldapURL</em></td>
<td align="left" valign="top">A URL that contains EIM domain controller
information.</td>
</tr>
</table>
<p>This URL has the following format:</p>
<pre>
ldap://host:port/dn
or
ldaps://host:port/dn
</pre>
<p>where:</p>
<ul>
<li><samp>host:port</samp> is the name of the host on which the EIM domain
controller is running with an optional port number.</li>
<li><samp>dn</samp> is the distinguished name for the domain entry.</li>
<li><samp>ldaps</samp> indicates that this host/port combination uses SSL and
TLS.</li>
</ul>
<p>Examples:</p>
<ul>
<li>ldap://systemx:389/ibm-eimDomainName=myEimDomain,o=myCompany,c=us</li>
<li>ldaps://systemy:636/ibm-eimDomainName=thisEimDomain</li>
</ul>
</dd>
</dl><br><br>
</li>
<li><em>localRegistry</em>
<dl>
<dd>The local EIM system registry name. The maximum size for this registry name
is 256 bytes.</dd>
<dd>
<p>Possible values are:</p>
<table cellpadding="3">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>NULL</em></td>
<td align="left" valign="top">A value of NULL indicates that it should not
change.</td>
</tr>
<tr>
<td align="left" valign="top" nowrap><em>EIM_CONFIG_NONE</em></td>
<td align="left" valign="top">(*NONE) This value indicates that there is no
local system registry.</td>
</tr>
<tr>
<td align="left" valign="top"><em>registry</em></td>
<td align="left" valign="top">The local EIM system registry name.</td>
</tr>
</table>
</dd>
</dl><br><br>
</li>
<li><em>kerberosRegistry</em>
<dl>
<dd>The EIM Kerberos registry name. The maximum size for this registry name is
256 bytes.</dd>
<dd>
<p>Possible values are:</p>
<table cellpadding="3">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>NULL</em></td>
<td align="left" valign="top">A value of NULL indicates that it should not
change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIM_CONFIG_NONE</em></td>
<td align="left" valign="top">(*NONE) This value indicates that there is no
kerberos registry for EIM.</td>
</tr>
<tr>
<td align="left" valign="top"><em>registry</em></td>
<td align="left" valign="top">The EIM Kerberos registry name. This is the
Kerberos realm name.</td>
</tr>
</table>
</dd>
</dl><br><br>
</li>
<li><em>x509Registry</em>
<dl>
<dd>The EIM X.509 registry name. The maximum size for this registry name is 256
bytes.</dd>
<dd>
<p>Possible values are:</p>
<table cellpadding="3">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>NULL</em></td>
<td align="left" valign="top">A value of NULL indicates that it should not
change.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIM_CONFIG_NONE</em></td>
<td align="left" valign="top">(*NONE) This value indicates that there is no
X.509 registry for EIM.</td>
</tr>
<tr>
<td align="left" valign="top"><em>registry</em></td>
<td align="left" valign="top">The EIM X.509 registry name. This is the registry
that will be used when adding source associations for user certificates to the
EIM identifier.</td>
</tr>
</table>
</dd>
</dl>
</li>
</ul>
<br>
<br>
</dd>
<dd><br>
<br>
<!-- ============================================================== -->
<!-- eimrc -->
<!-- ============================================================== --></dd>
<dt><strong>eimrc</strong>&nbsp;&nbsp;(Input/Output)</dt>
<dd>The structure in which to return error code information. If the return
value is not 0, eimrc is set with additional information. This parameter may be
NULL. For the format of the structure, see <a href="eimrc.htm">EimRC--EIM
Return Code Parameter</a>.<br>
<br>
</dd>
</dl>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- R E T U R N V A L U E -->
<!-- -->
<!-- ============================================================== -->
<h3>Return Value</h3>
<p>The return value from the API. Following each return value is the list of
possible values for the <samp>messageCatalogMessageID</samp> field in the <em>
eimrc</em> parameter for that value.</p>
<dl><!-- ============================================================== -->
<!-- 0 -->
<!-- ============================================================== -->
<dt><strong>0</strong></dt>
<dd>Request was successful.<br>
<br>
</dd>
<!-- ============================================================== -->
<!-- EACCES -->
<!-- ============================================================== -->
<dt><strong>EACCES</strong></dt>
<dd>Access denied.<br>
<br>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>EIMERR_AUTH_ERR (7)</em></td>
<td align="left" valign="top">Insufficient authority for the operation.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- EBADDATA -->
<!-- ============================================================== -->
<dt><strong>EBADDATA</strong></dt>
<dd>eimrc is not valid.<br>
<br>
</dd>
<!-- ============================================================== -->
<!-- EBUSY -->
<!-- ============================================================== -->
<dt><strong>EBUSY</strong></dt>
<dd>Unable to allocate internal system object.<br>
<br>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>EIMERR_NOLOCK (26)</em></td>
<td align="left" valign="top">Unable to allocate internal system object.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- ECONVERT -->
<!-- ============================================================== -->
<dt><strong>ECONVERT</strong></dt>
<dd>Data conversion error.<br>
<br>
<table cellpadding="5">
<!-- cols="35 65" -->
<tr>
<td align="left" valign="top"><em>EIMERR_DATA_CONVERSION (13)</em></td>
<td align="left" valign="top">Error occurred when converting data between code
pages.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- EINVAL -->
<!-- ============================================================== -->
<dt><strong>EINVAL</strong></dt>
<dd>Input parameter was not valid.<br>
<br>
<table cellpadding="5">
<!-- cols="35 65" -->
<tr>
<td align="left" valign="top"><em>EIMERR_CCSID_INVAL (8)</em></td>
<td align="left" valign="top">CCSID is outside of valid range or CCSID is not
supported.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_CHAR_INVAL (21)</em></td>
<td align="left" valign="top">A restricted character was used in the object
name. Check the API for a list of restricted characters.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_PTR_INVAL (35)</em></td>
<td align="left" valign="top">Pointer parameter is not valid.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_URL_NODN (45)</em></td>
<td align="left" valign="top">URL has no dn (required).</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_URL_NODOMAIN (46)</em></td>
<td align="left" valign="top">URL has no domain (required).</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_URL_NOHOST (47)</em></td>
<td align="left" valign="top">URL does not have a host.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_URL_NOTLDAP (49)</em></td>
<td align="left" valign="top">URL does not begin with ldap.</td>
</tr>
<tr>
<td align="left" valign="top"><em> EIMERR_INVALID_DN (66)</em></td>
<td align="left" valign="top">Distinguished Name (DN) is not valid.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_CONFIG_FORMAT_INVAL (68)</em></td>
<td align="left" valign="top">Configuration format is not valid.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- ENAMETOOLONG -->
<!-- ============================================================== -->
<dt><strong>ENAMETOOLONG</strong></dt>
<dd>ldapURL or registry name is too long.<br>
<br>
<table cellpadding="5">
<!-- cols="30 70" -->
<tr>
<td align="left" valign="top"><em>EIMERR_REGNAME_SIZE (39)</em></td>
<td align="left" valign="top">Registry name is too large.</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_URL_SIZE (51)</em></td>
<td align="left" valign="top">Configuration URL is too large.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- ENOMEM -->
<!-- ============================================================== -->
<dt><strong>ENOMEM</strong></dt>
<dd>Unable to allocate required space.<br>
<br>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>EIMERR_NOMEM (27)</em></td>
<td align="left" valign="top">No memory available. Unable to allocate required
space.</td>
</tr>
</table>
<br>
</dd>
<!-- ============================================================== -->
<!-- EUNKNOWN -->
<!-- ============================================================== -->
<dt><strong>EUNKNOWN</strong></dt>
<dd>Unexpected exception.<br>
<br>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>EIMERR_LDAP_ERR (23)</em></td>
<td align="left" valign="top">Unexpected LDAP error. %s</td>
</tr>
<tr>
<td align="left" valign="top"><em>EIMERR_UNKNOWN (44)</em></td>
<td align="left" valign="top">Unknown error or unknown system state.</td>
</tr>
</table>
</dd>
</dl>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- U S A G E N O T E S -->
<!-- -->
<!-- ============================================================== -->
<!-- ============================================================== -->
<!-- -->
<!-- R E L A T E D I N F O R M A T I O N -->
<!-- -->
<!-- ============================================================== -->
<h3>Related Information</h3>
<ul>
<li><a href="eimretrieveconfiguration.htm">eimRetrieveConfiguration()</a>
--Retrieve EIM Configuration<br>
<br>
</li>
</ul>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- E X A M P L E -->
<!-- -->
<!-- ============================================================== -->
<h3>Example</h3>
<p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a>
for information pertaining to code examples.</p>
<p>The following example sets the configuration information but it is not
enabled.</p>
<pre>
#include &lt;eim.h&gt;
#include &lt;stdio.h&gt;
int main(int argc, char *argv[])
{
int rc;
char eimerr[100];
EimRC * err;
EimConfigInfo configInfo;
<em>/* Set up error structure. */</em>
memset(eimerr,0x00,100);
err = (EimRC *)eimerr;
err-&gt;memoryProvidedByCaller = 100;
<em>/* Set up config information. */</em>
configInfo.format = EIM_CONFIG_FORMAT_0;
configInfo.enable = 0;
configInfo.ccsid = 0;
configInfo.config.format0.ldapURL =
"ldap://mysystem:389/ibm-eimDomainName=myEIMDomain,o=mycompany,c=us";
configInfo.config.format0.localRegistry = "mysystem";
configInfo.config.format0.kerberosRegistry = "krbprin";
configInfo.config.format0.x509Registry = "x509reg";
<em>/* Set config info, but it is disabled. */</em>
if (0 != (rc = eimSetConfigurationExt(&amp;.configInfo,
err)))
printf("Set configuration error = %d", rc);
return 0;
}
</pre>
<p>In this example, the configuration information is not changed but it is now
enabled for use.</p>
<pre>
#include &lt;eim.h&gt;
#include &lt;stdio.h&gt;
int main(int argc, char *argv[])
{
int rc;
char eimerr[100];
EimRC * err;
EimConfigInfo configInfo;
<em>/* Set up error structure. */</em>
memset(eimerr,0x00,100);
err = (EimRC *)eimerr;
err-&gt;memoryProvidedByCaller = 100;
<em>/* Set up config information. */</em>
configInfo.format = EIM_CONFIG_FORMAT_0;
configInfo.enable = 1;
configInfo.ccsid = 0;
configInfo.config.format0.ldapURL = NULL;
configInfo.config.format0.localRegistry = NULL;
configInfo.config.format0.kerberosRegistry = NULL;
configInfo.config.format0.x509Registry = NULL;
<em>/* Enable configuration info. */</em>
if (0 != (rc = eimSetConfigurationExt(&amp;configInfo,
err)))
printf("Set configuration error = %d", rc);
return 0;
}
</pre>
<br>
<!-- ============================================================== -->
<!-- -->
<!-- F O O T E R -->
<!-- -->
<!-- ============================================================== -->
<br>
<hr>
API introduced: V5R3
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"sec.htm">Security 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