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

732 lines
19 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>Update Client Information (QZCAUPDC, QzcaUpdateClientInfo) API</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. -->
<!-- QZCAUPDC SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
<!-- at RCHVMW2 on 20 Oct 1998 at 18:13:13 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited Oct 2001 by v2cdijab -->
<!--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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Update Client Information (QZCAUPDC, QzcaUpdateClientInfo) API</h2>
<div class="box" style="width: 80%;">
<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%">Client handle</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(12)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Client information list</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Length of client information list</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</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;Service Program: QZCACLT<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Update Client Information (OPM, QZCAUPDC; ILE, QzcaUpdateClientInfo) API
allows applications to update some miscellaneous information stored on the
system about a client.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>API Public Authority</em></dt>
<dd>*EXCLUDE</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Client handle</strong></dt>
<dd>INPUT; CHAR(12)
<p>A unique key to identify this managed node. This parameter was returned in
the client handle assigned parameter on the Add Client API.</p>
</dd>
<dt><strong>Client information list</strong></dt>
<dd>INPUT; CHAR(*)
<p>The information that should be updated at the server. For the format of this
structure, see <a href="#HDRCLTINFO">Client Information List</a>.</p>
</dd>
<dt><strong>Length of client information list</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the client information list area in bytes. Valid values are 16
through 1016.</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="HDRCLTINFO">Client Information List</a></h3>
<p>The client information list will have the following form:</p>
<table border="1">
<tr>
<th align="left" valign="top">Name</th>
<th align="left" valign="top">Type</th>
<th align="left" valign="top">Description</th>
</tr>
<tr>
<td align="left" valign="top" width="25%">Number of tokens</td>
<td align="left" valign="top" width="25%">BINARY(4)</td>
<td align="left" valign="top" width="50%">The number of tokens, which is the
same number of offsets, in the list. Valid values are 1 through 9.</td>
</tr>
<tr>
<td align="left" valign="top">Array of offsets to tokens</td>
<td align="left" valign="top">Array of BINARY(4)</td>
<td align="left" valign="top">Offset to token</td>
</tr>
<tr>
<td align="left" valign="top">...</td>
<td align="left" valign="top">...</td>
<td align="left" valign="top">...</td>
</tr>
<tr>
<td align="left" valign="top">Token</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">The field to be changed</td>
</tr>
<tr>
<td align="left" valign="top">Length of value</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">The length of the value</td>
</tr>
<tr>
<td align="left" valign="top">Value</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">The new value for the field to be changed</td>
</tr>
<tr>
<td align="left" valign="top">...</td>
<td align="left" valign="top">...</td>
<td align="left" valign="top">...</td>
</tr>
</table>
<p><strong>Notes:</strong></p>
<ol>
<li>Offsets are calculated from the beginning of the client information
list.</li>
<li>It is the responsibility of the calling application to ensure that all
binary fields are aligned on a 4-byte boundary.</li>
</ol>
<br>
<p><strong><a name="Header_5">Business Location (Token=1):</a></strong> The new
value for the business location field.</p>
<table border="1" 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%">Token</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 business location</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Business location</td>
</tr>
</table>
<br>
<br>
<p><strong><a name="Header_6">Community Name (Token=2):</a></strong> The new
value for the community name field.</p>
<table border="1" 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%">Token</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 community name</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Community name</td>
</tr>
</table>
<br>
<br>
<p><strong><a name="Header_7">Description (Token=3):</a></strong> The new value
for the description field.</p>
<table border="1" 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%">Token</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 description</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Description</td>
</tr>
</table>
<br>
<br>
<p><strong><a name="Header_8">Internet Address (Token=4):</a></strong> The new
value for the internet address field.</p>
<table border="1" 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%">Token</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 internet address</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Internet address</td>
</tr>
</table>
<br>
<br>
<p><strong><a name="Header_9">Office (Token=5):</a></strong> The new value for
the office field.</p>
<table border="1" 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%">Token</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 office</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Office</td>
</tr>
</table>
<br>
<br>
<p><strong><a name="Header_10">Owner (Token=6):</a></strong> The new value for
the owner field.</p>
<table border="1" 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%">Token</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 owner</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Owner</td>
</tr>
</table>
<br>
<br>
<p><strong><a name="Header_11">Owner Telephone (Token=7):</a></strong> The new
value for the owner telephone field.</p>
<table border="1" 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%">Token</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 owner telephone</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Owner telephone</td>
</tr>
</table>
<br>
<br>
<p><strong><a name="Header_12">Client Access User Profile
(Token=8):</a></strong> The new value for the Client Access user profile
field.</p>
<table border="1" 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%">Token</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 Client Access user profile</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Client Access user profile</td>
</tr>
</table>
<br>
<br>
<p><strong><a name="Header_13">Client Access Status (Token=9):</a></strong> The
new value for the Client Access status field.</p>
<table border="1" 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%">Token</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 Client Access status</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="center" valign="top">8</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Client Access status</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptions</h3>
<p><strong>Business location.</strong> The physical location of this
client.</p>
<p><strong>Client access status.</strong> The status of the Client Access
client.</p>
<p>The valid special values follow:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ACTIVE</em></td>
<td align="left" valign="top">Client Access has identified this client as
active.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*INACTIVE</em></td>
<td align="left" valign="top">Client Access has identified this client as
inactive.</td>
</tr>
</table>
<p><strong>Client Access user profile.</strong> An iSeries user profile.</p>
<p><strong>Community name.</strong> A relationship between a Simple Network
Management Protocol (SNMP) agent and a set of SNMP managers that are used for
authentication, access control, and proxy.</p>
<p><strong>Description.</strong> A user-defined description for this
client.</p>
<p><strong>Internet address.</strong> The internet address is specified in the
form nnn.nnn.nnn.nnn. Values for nnn range from 0 through 255.</p>
<p><strong>Length of business location.</strong> Values are from 0 through
255.</p>
<p><strong>Length of community name.</strong> Values are 0 through 255.</p>
<p><strong>Length of Client Access status.</strong> Values are from 7 through
10.</p>
<p><strong>Length of Client Access user profile.</strong> Values are from 0
through 10.</p>
<p><strong>Length of description.</strong> Values are from 0 through 255.</p>
<p><strong>Length of internet address.</strong> Values are from 7 through
15.</p>
<p><strong>Length of office.</strong> Values are from 0 through 32.</p>
<p><strong>Length of owner.</strong> Values are from 0 through 32.</p>
<p><strong>Length of owner telephone.</strong> Values are from 0 through
32.</p>
<p><strong>Office.</strong> The office of the owner for this client.</p>
<p><strong>Owner.</strong> The owner for this client.</p>
<p><strong>Owner telephone.</strong> The telephone number of the owner for this
client.</p>
<p><strong>Token.</strong> An integer value that defines the token you are
working with.</p>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top" width="15%">CPF24B4 E</td>
<td align="left" valign="top" width="85%">Severe error while addressing
parameter list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C1E E</td>
<td align="left" valign="top">Required parameter &amp;1 omitted.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C36 E</td>
<td align="left" valign="top">Number of parameters, &amp;1, entered for this
API was not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td align="left" valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF5E88 E</td>
<td align="left" valign="top">Parameter length not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF5E89 E</td>
<td align="left" valign="top">Client handle does not exist.</td>
</tr>
<tr>
<td align="left" valign="top">CPF5E95 E</td>
<td align="left" valign="top">Internal processing error.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9845 E</td>
<td align="left" valign="top">Error occurred while opening file &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9846 E</td>
<td align="left" valign="top">Error while processing file &amp;1 in library
&amp;2.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V3R6
<hr>
<center>
<table cellpadding="1" cellspacing="1">
<tr align="center">
<td valign="middle" align="center">
<a href="#top_Of_Page">Top</a> |
<a href="cms.htm">Client Management Support 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