ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qfparmve.htm

706 lines
22 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<!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>Remove Monitored Resource Entry (QfpadRmvMonitoredResourceEntry) 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. -->
<!-- Created for V5R4 on 040611 by EDDELEON -->
<!-- Change history: -->
<!-- YYMMDD INITIALS change description -->
<!-- DCR/PTR Rel Date Person : Description of change -->
<!-- D99682 5D40 040611 EDDELEON: New API -->
<!-- D99682 5D40 050720 NLKRYKA/RBIERLE: API review comments -->
<!-- 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><img src="delta.gif" alt="Start of change">Remove Monitored Resource Entry
(QfpadRmvMonitoredResourceEntry) API</h2>
<div class="box" style="width: 70%;">
<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%">Manager type</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Monitored resource information</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 monitored resource information</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">Format of monitored resource information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Server information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Length of server information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">Format of server information</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">8</td>
<td align="left" valign="top">Server defined output</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">9</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 Name: QFPADAP1<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Remove Monitored Resource Entry (QfpadRmvMonitoredResourceEntry) API
removes a Monitored Resource Entry (MRE) from the monitored resource directory.
A monitored resource may be a system object or a set of attributes not associated with a specific system object, such as the set
of system environment variables. Monitored resource entries are added using the Add Monitored Resource Entry (QfpadAddMonitoredResourceEntry) API.</p>
<p>This API will do the following when the manager type is *ADMDMN:</p>
<ul>
<li>Removes the monitored resource entries on all nodes in the cluster administrative domain.</li>
<li>Once the monitored resource entry is removed, changes to the monitored resource will not be synchronized
within the cluster administrative domain.</li>
<li>Any system objects that were created or any system environment variables that were added when a monitored resource was added to the monitored
resource directory will not be removed. The user must manually delete any resources that are no longer needed.</li>
</ul>
<p>This API requires the following if the manager type is *ADMDMN:</p>
<ul>
<li>When removing monitored resource entries from a cluster administrative domain, the cluster administrative domain must exist and all nodes in the domain must be active.</li>
<li>Resources and attributes cannot be removed from the monitored resource directory when
the cluster administration domain is partitioned.</li>
<li>The program that calls this API must be running under a user profile that exists on every node in the cluster administrative domain.</li>
<li>This API operates in an asynchronous mode. See
<a href="clust1a3.htm#HDRASYMOD">Behavior of Cluster Resource Services APIs</a>
for more information.</li>
</ul>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>General Authority</em></dt>
<dd>System configuration (*IOSYSCFG) special authority is required to use this API.</dd>
<dd>The caller of the API will need authority to retrieve the value of the monitored resource
entry's attributes on the source system and authority to create or change the monitored resource entry.</dd>
<dd><ul>
<li>Security Administrator (*SECADM) special authority is required to remove a monitored resource entry (MRE) for user profile.</li>
<li>Job Control (*JOBCTL) special authority is required to remove a monitored resource entry (MRE) for system environment variable.</li>
<li>*USE authority to the CHGSYSVAL command, plus the authority required to change the system value specified,
are required to remove a monitored resource entry (MRE) for system value.</li>
</ul></dd>
<dt><em>User queue</em></dt>
<dd>The following authorities and locks are required for the user queue specified in the results
information parameter.</dd>
<dd><em>User Queue Authority</em></dd>
<dd>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*OBJOPR and *ADD</dd>
<dd><em>User Queue Library Authority</em></dd>
<dd>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*EXECUTE</dd>
<dd><em>User Queue Lock</em></dd>
<dd>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*EXCLRD</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Manager type</strong></dt>
<dd>INPUT; CHAR(10)
<p>The management function which is to monitor the resource. *ADMDMN must be specified.</p>
</dd>
<dt><strong>Monitored resource information</strong></dt>
<dd>INPUT; CHAR(*)
<p>The monitored resource information provided as input.</p>
<dt><strong>Length of monitored resource information</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the monitored resource information.</p>
<dt><strong>Format of monitored resource information</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format name of the monitored resource information. The following format name is allowed:</p>
<p><a href="#Qfpad_EENT0100"><em>EENT0100</em></a> The format of monitored resource information in a cluster administrative domain.</p>
<dt><strong>Server information</strong></dt>
<dd>INPUT; CHAR(*)
<p>The information about the server where the monitored resource will be monitored by the system. When the manager type is *ADMDMN, the server is the cluster resource group associated with the cluster administrative domain.</p>
<dt><strong>Length of server information</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the server information.
The length of the server information parameter must be set to the size of the
SRVI0100 structure.</p>
<dt><strong>Format of server information</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format name of the server information. The following format name is allowed:</p>
<p><a href="#Qfpad_SRVI0100"><em>SRVI0100</em></a> The format of the server information when the server is a cluster.</p>
<dt><strong>Server defined output</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>When the manager type is *ADMDMN, the server defined output contains the 16 character request handle.
The request handle is a unique string or handle that identifies this API call. It is used to
associate this call to any responses placed on the user queue specified in the results information
parameter. The API will generate the request handle and return the handle to the caller of the API.</p>
<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>
<h3>Input Parameter Section</h3>
The following information is returned in the input parameter section. For
detailed descriptions of the fields in this table, see <a href="#field_desc">
Field Descriptions</a>.
<h3><a name="Qfpad_EENT0100">Monitored Resource Entry (EENT0100 Format)</a></h3>
<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="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%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Monitored resource type</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Monitored resource library name</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of monitored resource name</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Monitored resource name</td>
</tr>
</table>
<br>
<h3><a name="field_desc">Field Descriptions</a></h3>
<p><strong>Length of monitored resource name.</strong> The length in bytes of the monitored resource name.</p>
<p><strong>Monitored resource library name.</strong> The name of the monitored resource library. The allowed values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>Blank</em></td>
<td align="left" valign="top">Specify a blank monitored resource library name for the monitored resource entry types *SYSVAL, *ENVVAR, *NETA, or *TCPA.</td>
</tr>
<tr>
<td align="left" valign="top"><em>Monitored resource library name</em></td>
<td align="left" valign="top">Specify a monitored resource library name for the monitored resource entry types *USRPRF, *ASPDEV, *JOBD, and *CLS.
Monitored resource types of *USRPRF and *ASPDEV must specify QSYS for the monitored resource library name.
Library special values, e.g. *CURLIB or *LIBL, are not allowed.</td>
</tr>
</table>
<p><strong>Monitored resource name.</strong> The name of the monitored resource. </p>
<p><strong>Monitored resource type.</strong> The type of monitored resource. The allowed values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*USRPRF</em></td>
<td align="left" valign="top">User profile.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*JOBD</em></td>
<td align="left" valign="top">Job description.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CLS</em></td>
<td align="left" valign="top">Class.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ASPDEV</em></td>
<td align="left" valign="top">Independent auxiliary storage pool (ASP) device description.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SYSVAL</em></td>
<td align="left" valign="top">System value.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NETA</em></td>
<td align="left" valign="top">Network attribute.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ENVVAR</em></td>
<td align="left" valign="top">System environment variable.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*TCPA</em></td>
<td align="left" valign="top">TCP/IP attribute.</td>
</tr>
</table>
<h3><a name="Qfpad_SRVI0100">Server Information (SRVI0100 Format)</a></h3>
<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="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%">Length of server defined output</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Cluster name</td>
</tr>
<tr>
<td align="center" valign="top">14</td>
<td align="center" valign="top">E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Cluster administrative domain name</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(30)</td>
<td align="left" valign="top">Results information</td>
</tr>
</table>
<br>
<h3>Field Descriptions</h3>
<p><strong>Cluster administrative domain name.</strong> The name of the cluster administrative domain.</p>
<p><strong>Cluster name.</strong> The name of the cluster.</p>
<p><strong>Length of server defined output.</strong> The length, in bytes, of the server defined output parameter for this
API. If the manager type is *ADMDMN, this value must be 16.</p>
<p><strong>Results information.</strong> This field identifies a qualified user queue field and is followed by a
reserved field.</p>
<p>Qualified user queue: Completion information is returned to this user queue, which exists on the node from which the API
was called, after the function has completed. See the <a href="#usage_notes">Usage Notes</a> section of this API for a description of the data that
is placed on this queue. This is a 20-character field. The first 10 characters contain the user queue name, and the
second 10 characters contain the user queue library name. No special values are supported. QTEMP, *LIBL, *CURLIB are
not valid library names. The attributes of this user queue must be keyed.</p>
<p>Reserved: The last 10 characters of the results information are reserved and must be set to hexadecimal zero.</p>
<h3><a name="usage_notes">Usage Notes</a></h3>
<h4>Removing a Monitored Resource Entry (MRE) in a Cluster Administrative Domain</h4>
<p>See <a href="../rzaig/rzaigconceptsbasiccluster.htm">Cluster basics</a>
for more information about using this API to remove a monitored resource entry in a cluster administrative domain.</p>
<p>Unless otherwise specified, all character strings are assumed to be in the CCSID of the program that calls this API.</p>
<p>The following identifies the data sent to the user queue (excluding the message text).</p>
<table width="100%">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPCBB01 C</td>
<td width="85%" valign="top">Cluster Resource Services API &amp;1 completed.</td>
</tr>
<tr>
<td valign="top">CPF1999 D</td>
<td valign="top">Errors occurred on command.</td>
</tr>
<tr>
<td valign="top">CPF2204 D</td>
<td valign="top">User profile &amp;1 not found.</td>
</tr>
<tr>
<td valign="top">CPF3C21 D</td>
<td valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td valign="top">CPF3CF2 D</td>
<td valign="top">Error(s) occurred during running of &amp;1 API.</td>
</tr>
<tr>
<td valign="top">CPFBB17 D</td>
<td valign="top">&amp;1 API cannot be processed in cluster &amp;2.</td>
</tr>
<tr>
<td valign="top">CPFBB2D D</td>
<td valign="top">Timeout detected while waiting for a response.</td>
</tr>
<tr>
<td valign="top">CPFBB35 D</td>
<td valign="top">The user profile name &amp;1 is not valid for this request.</td>
</tr>
<tr>
<td valign="top">CPFBB39 E</td>
<td valign="top">Current user does not have IOSYSCFG special authority.</td>
</tr>
<tr>
<td valign="top">CPFBB47 D</td>
<td valign="top">
Cluster Resource Services detected an error and may have ended abnormally.</td>
</tr>
<tr>
<td valign="top">CPFBB48 D</td>
<td valign="top">Cluster Resource Services error detected.</td>
</tr>
<tr>
<td valign="top">CPFBBA1 D</td>
<td valign="top">All cluster command user queues busy.</td>
</tr>
<tr>
<td valign="top">CPFBBAB D</td>
<td valign="top">Node role &amp;1 not valid.</td>
</tr>
<tr>
<td valign="top">CPFBBB4 D</td>
<td valign="top">Create cluster administrative domain failed.</td>
</tr>
<tr>
<td valign="top">CPFBBB8 D</td>
<td valign="top">Cluster administrative domain already exists on cluster node &amp;1.</td>
</tr>
<tr>
<td valign="top">CPFBBB9 D</td>
<td valign="top">Cluster administrative domain &amp;1 internal error.</td>
</tr>
</table>
<h3><a name="header_9">Error Messages</a></h3>
<p>Messages that are delivered through the error code parameter are listed here. The data (messages) sent to the results
information user queue are listed in the <a href="#usage_notes">Usage Notes</a> above.</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">CPF1098 E</td>
<td valign="top">No authority to class &amp;1 in library &amp;2.</td>
</tr>
<tr>
<td valign="top">CPF2634 E</td>
<td valign="top">Not authorized to object &amp;1.</td>
</tr>
<tr>
<td valign="top">CPF2697 E</td>
<td valign="top">The request did not complete in the time allotted.</td>
</tr>
<tr>
<td valign="top">CPF3C1E E</td>
<td valign="top">Required parameter &amp;1 omitted.</td>
</tr>
<tr>
<td valign="top">CPF3C21 E</td>
<td valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C24 E</td>
<td valign="top">Length of the receiver variable is not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C29 E</td>
<td valign="top">Object name &amp;1 is not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C39 E</td>
<td valign="top">Value for reserved field not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C3C E</td>
<td valign="top">Value for parameter &amp;1 not valid.</td>
</tr>
<tr>
<td valign="top">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td valign="top">CPF3CF2 E</td>
<td valign="top">Error(s) occurred during running of &amp;1 API.</td>
</tr>
<tr>
<td valign="top">CPF9801 E</td>
<td valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td valign="top">CPF9802 E</td>
<td valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td valign="top">CPF9803 E</td>
<td valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td valign="top">CPF9804 E</td>
<td valign="top">Object &amp;2 in library &amp;3 damaged.</td>
</tr>
<tr>
<td valign="top">CPF9810 E</td>
<td valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td valign="top">CPF9820 E</td>
<td valign="top">Not authorized to use library &amp;1.</td>
</tr>
<tr>
<td valign="top">CPF9872 E</td>
<td valign="top">Program or service program &amp;1 in library &amp;2 ended. Reason code &amp;3.</td>
</tr>
<tr>
<td valign="top">CPFA0AA E</td>
<td valign="top">Error occurred while attempting to obtain space.</td>
</tr>
<tr>
<td valign="top">CPFAA03 E</td>
<td valign="top">Resource &amp;1 in library &amp;4 type &amp;3 cannot be removed for managed resource type &amp;2.</td>
</tr>
<tr>
<td valign="top">CPFB0CE E</td>
<td valign="top">&amp;1 special authority is required. </td>
</tr>
<tr>
<td valign="top">CPFBB02 E</td>
<td valign="top">Cluster &amp;1 does not exist.</td>
</tr>
<tr>
<td valign="top">CPFBB09 E</td>
<td valign="top">Cluster node &amp;1 does not exist in cluster &amp;2.</td>
</tr>
<tr>
<td valign="top">CPFBB0A E</td>
<td valign="top">Cluster node &amp;1 in cluster &amp;2 is not active.</td>
</tr>
<tr>
<td valign="top">CPFBB0F E</td>
<td valign="top"> Cluster resource group &amp;1 does not exist in cluster &amp;2.</td>
</tr>
<tr>
<td valign="top">CPFBB20 E</td>
<td valign="top">Cluster partition detected for cluster &amp;1 by cluster node &amp;2.</td>
</tr>
<tr>
<td valign="top">CPFBB26 E</td>
<td valign="top">Cluster Resource Services is not active or not responding.</td>
</tr>
<tr>
<td valign="top">CPFBB32 E</td>
<td valign="top">Attributes of user queue &amp;1 in library &amp;1 are not valid.</td>
</tr>
<tr>
<td valign="top">CPFBB39 E</td>
<td valign="top">Current user does not have IOSYSCFG special authority.</td>
</tr>
<tr>
<td valign="top">CPFBB46 E</td>
<td valign="top">Cluster Resource Services internal error.</td>
</tr>
<tr>
<td valign="top">CPFBBB6 E</td>
<td valign="top">Library &amp;1 not allowed for resource &amp;2.</td>
</tr>
</table>
<br>
<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="ss1.htm">Server Support APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
</body>
</html>