238 lines
14 KiB
HTML
238 lines
14 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE html
|
||
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html lang="en-us" xml:lang="en-us">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<meta name="security" content="public" />
|
||
|
|
<meta name="Robots" content="index,follow" />
|
||
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
||
|
|
<meta name="DC.Type" content="reference" />
|
||
|
|
<meta name="DC.Title" content="System object attributes list" />
|
||
|
|
<meta name="abstract" content="Following is a list of system object attributes. It includes descriptions, requirements, and considerations." />
|
||
|
|
<meta name="description" content="Following is a list of system object attributes. It includes descriptions, requirements, and considerations." />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzaiksyapisysobjattr.htm" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 1999, 2006" />
|
||
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1999, 2006" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="syapisysobjattrlist" />
|
||
|
|
<meta name="DC.Language" content="en-us" />
|
||
|
|
<!-- 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. -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
||
|
|
<title>System object attributes list</title>
|
||
|
|
</head>
|
||
|
|
<body id="syapisysobjattrlist"><a name="syapisysobjattrlist"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">System object attributes list</h1>
|
||
|
|
<div><p>Following is a list of system object attributes. It includes descriptions,
|
||
|
|
requirements, and considerations.</p>
|
||
|
|
<div class="section"><p>Also listed with each attribute are: </p>
|
||
|
|
<ul><li>The APIs that you can use to get and to set it</li>
|
||
|
|
<li>What its default value is when the system object is created</li>
|
||
|
|
</ul>
|
||
|
|
<div class="note"><span class="notetitle">Note:</span> The attributes' settings apply ONLY to the system object for which
|
||
|
|
they are set, NOT to any other system objects, even if other system objects
|
||
|
|
have the same iSeries™ system
|
||
|
|
name.</div>
|
||
|
|
</div>
|
||
|
|
<div class="section"> <dl><dt class="dlterm">iSeries system
|
||
|
|
name:</dt>
|
||
|
|
<dd>The iSeries system
|
||
|
|
with which to communicate and use by way of this instance of a system object.
|
||
|
|
This can be set only at the time <a href="rzaikcwbcocreatesystem.htm#cwbco_createsystem">cwbCO_CreateSystem</a> or <a href="rzaikcwbcocreatesystemlike.htm#cwbco_createsystemlike">cwbCO_CreateSystemLike</a> is
|
||
|
|
called. Note that the system name is used as the unique identifier when validating
|
||
|
|
security information for a specific user ID: If two different system objects
|
||
|
|
contain different system names that represent the same physical iSeries system,
|
||
|
|
the user ID and password require separate validation for the two system objects.
|
||
|
|
For example, this applies if the system names "SYS1" and "SYS1.ACME.COM" represent
|
||
|
|
the same iSeries system.
|
||
|
|
This may result in double prompting, and the use of different default user
|
||
|
|
IDs when connecting. <p>Get by using <a href="rzaikcwbcogetsystemname.htm#cwbco_getsystemname">cwbCO_GetSystemName</a></p>
|
||
|
|
<dl><dt class="dlterm">Default:</dt>
|
||
|
|
<dd>There is no default, since this is explicitly set when the system object
|
||
|
|
is created.</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">Description</dt>
|
||
|
|
<dd>Description of the configured connection to the iSeries system. <p>Set using iSeries Navigator.</p>
|
||
|
|
<p>Retrieve
|
||
|
|
using <a href="cwbco_getdescription.htm#cwbco_getdescription">cwbCO_GetDescription</a></p>
|
||
|
|
<p>The
|
||
|
|
description is stored with each system object, and never changed for that
|
||
|
|
system object. If the description is changed using iSeries Navigator, system objects for
|
||
|
|
that system that existed before the change was made are not changed. Only
|
||
|
|
new system objects will contain the new description. </p>
|
||
|
|
<dl><dt class="dlterm">Default:</dt>
|
||
|
|
<dd>Blank. This may be overridden by policies.</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">User ID:</dt>
|
||
|
|
<dd>The user ID used to logon to the iSeries system. <p>Get by using <a href="rzaikcwbcogetuseridex.htm#cwbco_getuseridex">cwbCO_GetUserIDEx</a></p>
|
||
|
|
<p>Set
|
||
|
|
by using <a href="rzaikcwbcosetuseridex.htm#cwbco_setuseridex">cwbCO_SetUserIDEx</a></p>
|
||
|
|
<dl><dt class="dlterm">Default:</dt>
|
||
|
|
<dd>The first time that you connect to the iSeries system which is named in the
|
||
|
|
system object, you may be prompted: <ul><li>To specify a default user ID</li>
|
||
|
|
<li>To specify that the default user ID should be the same as your Windows<sup>®</sup> user
|
||
|
|
ID</li>
|
||
|
|
<li>That no default will be used</li>
|
||
|
|
</ul>
|
||
|
|
On subsequent connection attempts, the default user ID that is used will
|
||
|
|
depend on which option you chose when prompted during the first connection
|
||
|
|
attempt.</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">Password:</dt>
|
||
|
|
<dd>The password used to signon to the iSeries system. <p>Set by using <a href="rzaikcwbcosetpassword.htm#cwbco_setpassword">cwbCO_SetPassword</a></p>
|
||
|
|
<dl><dt class="dlterm">Default:</dt>
|
||
|
|
<dd>Blank (no password set) if the user ID that is set in the system object
|
||
|
|
never has signed on to the iSeries system that is named in the system object.
|
||
|
|
If a previous successful signon or connection has been made to the iSeries system
|
||
|
|
that is named in the system object, that password may be used for the next
|
||
|
|
signon or connection attempt. The system will no longer cache a password in
|
||
|
|
the iSeries Access
|
||
|
|
for Windows volatile
|
||
|
|
password cache if the password comes in through the cwbCO_SetPassword( ) API.
|
||
|
|
Previously, this would have gone into the volatile (i.e. session) password
|
||
|
|
cache. </dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">Default user mode:</dt>
|
||
|
|
<dd>Controls behavior that is associated with the default user ID, including
|
||
|
|
where to obtain it and whether to use it. If it is not set (if the value is
|
||
|
|
CWBCO_DEFAULT_USER_MODE_NOT_SET), the user may be prompted to choose which
|
||
|
|
behavior is desired at the time a signon is attempted.
|
||
|
|
<p>Get by using <a href="rzaikcwbcogetdefaultusermode.htm#cwbco_getdefaultusermode">cwbCO_GetDefaultUserMode</a></p>
|
||
|
|
<p>Set
|
||
|
|
by using <a href="rzaikcwbcosetdefaultusermode.htm#cwbco_setdefaultusermode">cwbCO_SetDefaultUserMode</a></p>
|
||
|
|
<p>Check
|
||
|
|
for modify restriction by using <a href="rzaikcwbcocanmodifydefaultusermode.htm#cwbco_canmodifydefaultusermode">cwbCO_CanModifyDefaultUserMode</a></p>
|
||
|
|
<dl><dt class="dlterm">Default:</dt>
|
||
|
|
<dd>CWBCO_DEFAULT_USER_MODE_NOT_SET <div class="note"><span class="notetitle">Note:</span> The default may be overridden by
|
||
|
|
policies.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">Prompt mode:</dt>
|
||
|
|
<dd>Controls when iSeries Access for Windows will prompt the user for user
|
||
|
|
ID and password. See the declaration comments for <a href="rzaikcwbcosetpromptmode.htm#cwbco_setpromptmode">cwbCO_SetPromptMode</a> for
|
||
|
|
possible values and for associated behaviors.
|
||
|
|
<p>Get by using <a href="rzaikcwbcogetpromptmode.htm#cwbco_getpromptmode">cwbCO_GetPromptMode</a></p>
|
||
|
|
<p>Set
|
||
|
|
by using <a href="rzaikcwbcosetpromptmode.htm#cwbco_setpromptmode">cwbCO_SetPromptMode</a></p>
|
||
|
|
<dl><dt class="dlterm">Default:</dt>
|
||
|
|
<dd>CWBCO_PROMPT_IF_NECESSARY</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">Window handle:</dt>
|
||
|
|
<dd>The window handle of the calling application. If this is set, any prompting
|
||
|
|
that iSeries Access
|
||
|
|
for Windows does
|
||
|
|
related to iSeries signon
|
||
|
|
will use the window handle, and will be modal to the associated window. This
|
||
|
|
means that the prompt never will be hidden UNDER the main application window
|
||
|
|
if its handle is associated with the system object. If no window handle is
|
||
|
|
set, the prompt might be hidden behind the main application window, if one
|
||
|
|
exists.<p>Get by using <a href="rzaikcwbcogetwindowhandle.htm#cwbco_getwindowhandle">cwbCO_GetWindowHandle</a></p>
|
||
|
|
<p>Set
|
||
|
|
by using <a href="rzaikcwbcosetwindowhandle.htm#cwbco_setwindowhandle">cwbCO_SetWindowHandle</a></p>
|
||
|
|
<dl><dt class="dlterm">Default:</dt>
|
||
|
|
<dd>NULL (not set)</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">Validate mode:</dt>
|
||
|
|
<dd>Specifies, when validating user ID and password, whether communication
|
||
|
|
with the iSeries system
|
||
|
|
to perform this validation actually occurs. See the declaration comments for <a href="rzaikcwbcosetvalidatemode.htm#cwbco_setvalidatemode">cwbCO_SetValidateMode</a> and <a href="rzaikcwbcogetvalidatemode.htm#cwbco_getvalidatemode">cwbCO_GetValidateMode</a> for
|
||
|
|
possible values and for associated behaviors. <p>Get by using <a href="rzaikcwbcogetvalidatemode.htm#cwbco_getvalidatemode">cwbCO_GetValidateMode</a></p>
|
||
|
|
<p>Set by using <a href="rzaikcwbcosetvalidatemode.htm#cwbco_setvalidatemode">cwbCO_SetValidateMode</a></p>
|
||
|
|
<dl><dt class="dlterm">Default:</dt>
|
||
|
|
<dd>CWBCO_VALIDATE_IF_NECESSARY</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">Use Secure Sockets:</dt>
|
||
|
|
<dd>Specifies whether iSeries Access for Windows will use secure sockets to authenticate
|
||
|
|
the server (iSeries system)
|
||
|
|
and to encrypt data that is sent and received. There are some cases where
|
||
|
|
secure sockets cannot be used (for example, when the software support for
|
||
|
|
Secure Sockets has not been installed on the PC). Accordingly, an application
|
||
|
|
or user request for secure sockets use may fail, either at the time the cwbCO_UseSecureSockets
|
||
|
|
API is called, or at connect time. If no such failure occurs, then secure
|
||
|
|
sockets is being used, and cwbCO_IsSecureSockets will return CWB_TRUE. <p>Get
|
||
|
|
by using <a href="rzaikcwbcoissecuresockets.htm#cwbco_issecuresockets">cwbCO_IsSecureSockets</a></p>
|
||
|
|
<p>Set
|
||
|
|
by using <a href="rzaikcwbcousesecuresockets.htm#cwbco_usesecuresockets">cwbCO_UseSecureSockets</a></p>
|
||
|
|
<p>Check
|
||
|
|
for modify restriction by using <a href="rzaikcwbcocanmodifyusesecuresockets.htm#cwbco_canmodifyusesecuresockets">cwbCO_CanModifyUseSecureSockets</a></p>
|
||
|
|
<dl><dt class="dlterm">Default:</dt>
|
||
|
|
<dd>Whatever has been configured for this iSeries system in the System List will
|
||
|
|
be used. If no configuration for this iSeries system exists, or if the configuration
|
||
|
|
specifies to use the iSeries Access default, then secure sockets will
|
||
|
|
not be used (CWB_FALSE). <div class="note"><span class="notetitle">Note:</span> The default may be overridden by policies.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">Port lookup mode:</dt>
|
||
|
|
<dd>Specifies how to retrieve the remote port for an iSeries host service. It specifies whether
|
||
|
|
to look it up locally (on the PC), on the iSeries system, or to simply use the
|
||
|
|
default ("standard") port for the specified service. If local lookup is selected,
|
||
|
|
the standard TCP/IP method of lookup in the SERVICES file on the PC is used.
|
||
|
|
If server lookup is specified, a connection to the iSeries system server mapper is made
|
||
|
|
to retrieve the port number by lookup from the iSeries system service table. If either
|
||
|
|
the local or server lookup method fails, then connecting to the service will
|
||
|
|
fail. For more information and for possible values, see the API declaration
|
||
|
|
for cwbCO_SetPortLookupMode. <p>Get by using <a href="rzaikcwbcogetportlookupmode.htm#cwbco_getportlookupmode">cwbCO_GetPortLookupMode</a></p>
|
||
|
|
<p>Set by using <a href="rzaikcwbcosetportlookupmode.htm#cwbco_setportlookupmode">cwbCO_SetPortLookupMode</a></p>
|
||
|
|
<p>Check
|
||
|
|
for modify restriction by using <a href="rzaikcwbcocanmodifyportlookupmode.htm#cwbco_canmodifyportlookupmode">cwbCO_CanModifyPortLookupMode</a></p>
|
||
|
|
<dl><dt class="dlterm">Default:</dt>
|
||
|
|
<dd>Whatever has been configured for this iSeries system in the System List will
|
||
|
|
be used. If no configuration for this iSeries system exists, the default is
|
||
|
|
CWBCO_PORT_LOOKUP_SERVER. <div class="note"><span class="notetitle">Note:</span> The default may be overridden by policies.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">Persistence mode:</dt>
|
||
|
|
<dd>Specifies whether the iSeries system named in this system object may be
|
||
|
|
added to the System List (if not already in the list) once a successful call
|
||
|
|
to <a href="rzaikcwbcoconnect.htm#cwbco_connect">cwbCO_Connect</a> has
|
||
|
|
completed. See <a href="rzaikcwbcosetpersistencemode.htm#cwbco_setpersistencemode">cwbCO_SetPersistenceMode</a> for
|
||
|
|
more information and for possible values. <p>Get by using <a href="rzaikcwbcogetpersistencemode.htm#cwbco_getpersistencemode">cwbCO_GetPersistenceMode</a></p>
|
||
|
|
<p>Set by using <a href="rzaikcwbcosetpersistencemode.htm#cwbco_setpersistencemode">cwbCO_SetPersistenceMode</a></p>
|
||
|
|
<p>Check
|
||
|
|
for modify restriction by using <a href="rzaikcwbcocanmodifypersistencemode.htm#cwbco_canmodifypersistencemode">cwbCO_CanModifyPersistenceMode</a></p>
|
||
|
|
<dl><dt class="dlterm">Default:</dt>
|
||
|
|
<dd>CWBCO_MAY_MAKE_PERSISTENT <div class="note"><span class="notetitle">Note:</span> The default may be overridden by policies.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
<dt class="dlterm">Connect timeout</dt>
|
||
|
|
<dd>Specifies how long iSeries Access for Windows will wait for a connection attempt
|
||
|
|
to complete. This setting does not affect how long the TCP/IP communications
|
||
|
|
stack will wait before giving up. The TCP/IP communications stack might timeout
|
||
|
|
before the iSeries Access
|
||
|
|
connection timeout has expired. See <a href="cwbco_setconnecttimeout.htm#cwbco_setconnecttimeout">cwbCO_SetConnectTimeout</a> for
|
||
|
|
more information and possible values. This value may be changed for a system
|
||
|
|
object at any time. <p>get using <a href="cwbco_getconnecttimeout.htm#cwbco_getconnecttimeout">cwbCO_GetConnectTimeout</a></p>
|
||
|
|
<p>set
|
||
|
|
using <a href="cwbco_setconnecttimeout.htm#cwbco_setconnecttimeout">cwbCO_SetConnectTimeout</a></p>
|
||
|
|
<dl><dt class="dlterm">Default:</dt>
|
||
|
|
<dd> CWBCO_CONNECT_TIMEOUT_DEFAULT <div class="note"><span class="notetitle">Note:</span> The default may be overridden by
|
||
|
|
policies.</div>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaiksyapisysobjattr.htm" title="System object attributes affect the behavior of signing on and communicating with the iSeries system that the system object represents.">System object attributes</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|