365 lines
9.9 KiB
HTML
365 lines
9.9 KiB
HTML
<!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">
|
|
<!-- 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. -->
|
|
<!-- Created for V5R4 by Sergio Toscano (stlomeli) D93040 -->
|
|
<!-- Reason vXrYmZ Dev Date Change -->
|
|
<!-- Reason v5r4m0 stlomeli 031505 Add max PTF order size -->
|
|
<title>Set User Policy (QPDETPOL) API</title>
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
<!--End Header Records ================================================ -->
|
|
<!-- Java sync-link =================================================== -->
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
|
</script>
|
|
|
|
<a name="Top_Of_Page"></a>
|
|
|
|
<h2><img src="delta.gif" alt="Start of change">Set User Policy (QPDETPOL) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
|
|
<br>
|
|
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%">Policy data</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">2</td>
|
|
<td align="left" valign="top" width="50%">Length of policy data</td>
|
|
<td align="left" valign="top" width="20%">Input</td>
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Format of policy data</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(8)</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>
|
|
Default Public Authority: *EXCLUDE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
|
|
</div>
|
|
|
|
<p>The Set User Policy (QPDETPOL) API allows the changing
|
|
of user policies related to service. This includes: </p>
|
|
<ul>
|
|
<li>How long to retain service related information</li>
|
|
<li>What level of information to send when the system
|
|
automatically reports a problem to a service provider</li>
|
|
<li>What is the maximum size for a PTF order to be delivered electronically</li>
|
|
</ul>
|
|
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<em>User Profile Authority</em>
|
|
<br><br>
|
|
<dl><dd>*SERVICE</dd></dl>
|
|
|
|
|
|
|
|
<br>
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Policy data</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>Information to use when setting the policy.</p>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Length of policy data</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>How long the policy data is.</p>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
|
|
<dt><strong>Format of policy data</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>Which policy to set. Only the following values are accepted.</p>
|
|
|
|
<table cellpadding="5" border="1">
|
|
<!-- cols="25 75" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em><a href="#pols0100">POLS0100</a></em></td>
|
|
<td align="left" valign="top">Set service cleanup interval policy.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em><a href="#pols0200">POLS0200</a></em></td>
|
|
<td align="left" valign="top">Set problem documentation level.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em><a href="#pols0300">POLS0300</a></em></td>
|
|
<td align="left" valign="top">Set maximum PTF order size.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<br>
|
|
</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>
|
|
|
|
<br>
|
|
|
|
<h3><a name="pols0100">POLS0100 - Format for setting service inteval policy for Service Monitor cleanup</a></h3>
|
|
|
|
<p>The following information needs to be supplied in the policy data
|
|
parameter (parameter 1) for the POLS0100 format.</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="left" valign="bottom">Dec</th>
|
|
<th align="left" 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%">Number of days</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3><a name="pols0200">POLS0200 - Format for setting the level of problem documentation sent with a problem</a></h3>
|
|
|
|
<p>The following information needs to be supplied in the policy data
|
|
parameter (parameter 1) for the POLS0200 format. </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="left" valign="bottom">Dec</th>
|
|
<th align="left" 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%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">Problem documentation level</td>
|
|
</tr>
|
|
</table>
|
|
<br>
|
|
<br>
|
|
|
|
<h3><a name="pols0300">POLS0300 - Format for setting maximum PTF order size</a></h3>
|
|
|
|
<p>The following information needs to be supplied in the policy data
|
|
parameter (parameter 1) for the POLS0300 format.</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="left" valign="bottom">Dec</th>
|
|
<th align="left" 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%">Maximum PTF order size over LAN</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">4</td>
|
|
<td align="center" valign="top" width="10%">4</td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Maximum PTF order size over a modem</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="Header_8">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Maximum PTF order size over a modem.</strong> The maximum size in megabytes for
|
|
a PTF order to be delivered electronically over a modem.
|
|
This policy is shipped with a default value of 100 MB (MB equals approximately 1 000 000 bytes).
|
|
If -1 is specified, PTF orders of any size are delivered
|
|
over a modem.
|
|
This policy cannot be set to a value less than 100 MB.</p>
|
|
|
|
<p><strong>Maximum PTF order size over LAN.</strong> The maximum size in megabytes for
|
|
a PTF order to be
|
|
delivered electronically over the local area network (LAN).
|
|
If -1 is specified, PTF orders of any size are delivered over the LAN.
|
|
This policy is shipped with a default value of -1.
|
|
This policy cannot be set to a value less than 100 MB (MB equals approximately 1 000 000 bytes).</p>
|
|
|
|
<p><strong>Number of days.</strong> The number of days an object covered by this policy is allowed to
|
|
exist before being deleted by the Service Monitor. Objects covered by this policy are: Service Monitor logs
|
|
and Integrated File System files created by the FFDC process.</p>
|
|
|
|
<p><strong>Problem documentation level.</strong> Indicates how much problem documentation
|
|
should be included when problems are automatically reported to the service provider.
|
|
Only the following values are accepted:</p>
|
|
<table cellpadding="5" border="1" width="80%">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*BASE</em></td>
|
|
<td align="left" valign="top">Minimal documentation is sent in the service request record.
|
|
No additional data will be uploaded.</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left" valign="top"><em>*DEFAULT</em></td>
|
|
<td align="left" valign="top">Minimal documentation will be sent in the service request record.
|
|
If no fix for the problem is found, additional documentation will be automatically uploaded.
|
|
Additional documentation may include information such as joblogs and service dumps.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3>Error Messages</h3>
|
|
|
|
<p>The following messages may be sent from this function:</p>
|
|
|
|
<table width="100%">
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPFE080</td>
|
|
<td valign="top">Maximum PTF order size not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF0CC1</td>
|
|
<td width="85%" valign="top">Error initializing the XML parser.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF24B4</td>
|
|
<td valign="top">Severe error while addressing parameter list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3CF1</td>
|
|
<td valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3CF2</td>
|
|
<td valign="top">Error(s) occurred during running of &1 API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C1E</td>
|
|
<td valign="top">Required parameter &1 omitted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C21</td>
|
|
<td valign="top">Format name &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF3C3A</td>
|
|
<td valign="top">Value for parameter &2 for API &1 not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td valign="top">CPF9872</td>
|
|
<td valign="top">Program or service program &1 in library &2 ended.
|
|
Reason code &3.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<br>
|
|
<img src="deltaend.gif" alt="End of change">
|
|
|
|
<hr>
|
|
API introduced: V5R4
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"pm1.htm">Problem Management APIs</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|