<!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>Refresh Client Information (QZCAREFC, QzcaRefreshClientInfo) 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.                         -->
<!-- QZCAREFC SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA  -->
<!-- at RCHVMW2 on 20 Oct 1998 at 18:16:06                           -->
<!-- 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>Refresh Client Information (QZCAREFC, QzcaRefreshClientInfo) 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">Information type</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>

<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Time out</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 Refresh Client Information (OPM, QZCAREFC; ILE, QzcaRefreshClientInfo)
API allows applications to refresh hardware, software, or all information
stored on the server with the information stored at the 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>Information type</strong></dt>

<dd>INPUT; CHAR(10) 

<p>The information that should be refreshed at the server.</p>

<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">Client details, hardware, and software
information should be refreshed at the server.</td>
</tr>

<tr>
<td align="left" valign="top"><em>*HDW</em></td>
<td align="left" valign="top">Only hardware information needs to be refreshed
at the server.</td>
</tr>

<tr>
<td align="left" valign="top"><em>*SFW</em></td>
<td align="left" valign="top">Only software information needs to be refreshed
at the server.</td>
</tr>
</table>

<br>
</dd>

<dt><strong>Time out</strong></dt>

<dd>INPUT; BINARY(4) 

<p>The amount of time to wait for a client response. The value specified is in
units of seconds. Valid values are 1 through 100.</p>

<p><strong>Note:</strong> This is not a time-out value for this API. It is a
time-out for each SNMP call that this API makes to the client.</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>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%">CPFA835 E</td>
<td align="left" valign="top" width="85%">Time-out parameter not correct.</td>
</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">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">CPF5E87 E</td>
<td align="left" valign="top">Information type 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">CPF5E8E E</td>
<td align="left" valign="top">Unable to contact client.</td>
</tr>

<tr>
<td align="left" valign="top">CPF5E94 E</td>
<td align="left" valign="top">Client information not refreshed.</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>