ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/addalracne.htm

396 lines
11 KiB
HTML
Raw 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">
<title>Add Alert Action Entry (ADDALRACNE)</title>
</head>
<body bgcolor="white">
<a name="ADDALRACNE.Top_Of_Page"></a>
<h2>Add Alert Action Entry (ADDALRACNE)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#ADDALRACNE.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ADDALRACNE.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ADDALRACNE.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ADDALRACNE"></a>
<p>The Add Alert Action Entry (ADDALRACNE) command allows the user to add an action entry to the specified alert filter. This entry describes the actions that should be taken for an alert that has been assigned to the specified group. More information on alerts is in the Alerts Support book, SC41-5413.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDALRACNE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDALRACNE.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#ADDALRACNE.FILTER"><b>FILTER</b></a></td>
<td valign="top">Filter</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Required, Positional 1</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Filter</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top"><a href="#ADDALRACNE.GROUP"><b>GROUP</b></a></td>
<td valign="top">Group</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#ADDALRACNE.LOG"><b>LOG</b></a></td>
<td valign="top">Log alert</td>
<td valign="top">*YES, *NO, <b><u>*NETATR</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDALRACNE.ASNUSER"><b>ASNUSER</b></a></td>
<td valign="top">User assigned</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#ADDALRACNE.SEND"><b>SEND</b></a></td>
<td valign="top">Send to system</td>
<td valign="top">Single values: <b><u>*NONE</u></b><br>Other values (up to 5 repetitions): <i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Network identifier</td>
<td valign="top">
<i>Communications name</i>, *NETATR, *FOCALPT</td>
</tr>
<tr>
<td valign="top">Element 2: Control point</td>
<td valign="top">
<i>Communications name</i></td>
</tr>
<tr>
<td valign="top" rowspan="5"><a href="#ADDALRACNE.SNDDTAQ"><b>SNDDTAQ</b></a></td>
<td valign="top">Send to data queue</td>
<td valign="top">Single values: <b><u>*NONE</u></b><br>Other values (up to 5 repetitions): <i>Element list</i></td>
<td valign="top" rowspan="5">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Data queue</td>
<td valign="top">
<i>Qualified object name</i></td>
</tr>
<tr>
<td valign="top" style="padding-left:10pt">Qualifier 1: Data queue</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top" style="padding-left:10pt">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top">Element 2: Data queue key</td>
<td valign="top">
<i>Character value</i>, <b><u>*NONE</u></b>, X''</td>
</tr>
<tr>
<td valign="top"><a href="#ADDALRACNE.GENTRAP"><b>GENTRAP</b></a></td>
<td valign="top">Generate SNMP trap</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#ADDALRACNE.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ADDALRACNE.FILTER"></a>
<h3>Filter (FILTER)</h3>
<p>Specifies the filter to which the action entry is to be added.
</p>
<p>This is a required parameter.
</p>
<p><b>Qualifier 1: Filter</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the filter.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the job's library list are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the filter. If no library is specified as the current library for the job, the QGPL library is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library where the filter is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDALRACNE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDALRACNE.GROUP"></a>
<h3>Group (GROUP)</h3>
<p>Specifies the group name to which the defined actions are to be applied. The group name is assigned from the selection criteria in the filter.
</p>
<p>This is a required parameter.
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the group name.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDALRACNE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDALRACNE.LOG"></a>
<h3>Log alert (LOG)</h3>
<p>Specifies whether the alert is logged.
</p>
<dl>
<dt><b><u>*NETATR</u></b></dt>
<dd>The ALRLOGSTS network attribute controls the logging of this alert.
</dd>
<dt><b>*YES</b></dt>
<dd>The alert is logged.
</dd>
<dt><b>*NO</b></dt>
<dd>The alert is not logged.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDALRACNE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDALRACNE.ASNUSER"></a>
<h3>User assigned (ASNUSER)</h3>
<p>Specifies the user to be assigned to the alert.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No user is specified.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify a user name.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDALRACNE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDALRACNE.SEND"></a>
<h3>Send to system (SEND)</h3>
<p>Specifies the destination to which the alert is to be sent. An alert cannot be sent to the local system. The system checks for this action when the alert is sent.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>The alert is not sent.
</dd>
</dl>
<p><b>Other values (up to 5 repetitions)</b>
</p>
<p><b>Element 1: Network identifier</b>
</p>
<dl>
<dt><b>*FOCALPT</b></dt>
<dd>Sends the alert to the system focal point. The focal point system is determined at send time.
</dd>
<dt><b>*NETATR</b></dt>
<dd>The LCLNETID value specified in the system network attributes is used.
</dd>
<dt><b><i>communications-name</i></b></dt>
<dd>Specify the network ID of the destination node.
</dd>
</dl>
<p><b>Element 2: Control point</b>
</p>
<dl>
<dt><b><i>communications-name</i></b></dt>
<dd>Specify the control point name of the destination system.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDALRACNE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDALRACNE.SNDDTAQ"></a>
<h3>Send to data queue (SNDDTAQ)</h3>
<p>Specifies the data queue in which an alert notification record is placed. Keyed data queues are supported.
</p>
<p>The data queue name can be qualified by one of the following library values:
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No data queue is used.
</dd>
</dl>
<p><b>Other values (up to 5 repetitions)</b>
</p>
<p><b>Element 1: Data queue</b>
</p>
<dl>
<dt><b></b></dt>
<dd>
<p><b>Qualifier 1: Data queue</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the data queue.
</dd>
</dl>
</dd>
<dt><b></b></dt>
<dd>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the job's library list are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the data queue. If no library is specified as the current library for the job, the QGPL library is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library where the data queue is located.
</dd>
</dl>
</dd>
</dl>
<p><b>Element 2: Data queue key</b>
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No key is used on the data queue.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the data queue key.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDALRACNE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDALRACNE.GENTRAP"></a>
<h3>Generate SNMP trap (GENTRAP)</h3>
<p>Specifies whether the alert generates an SNMP trap.
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>An SNMP trap is not generated from this alert.
</dd>
<dt><b>*YES</b></dt>
<dd>An SNMP trap is generated from this alert.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDALRACNE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDALRACNE.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
ADDALRACNE FILTER(MYLIB/MYFILTER) GROUP(CHICAGO)
LOG(*NETATR) ASNUSER(CHICAGOOPR)
SEND((*FOCALPT) (*NETATR.MILWKEE))
SNDDTAQ(*LIBL/ALERTDTAQ)
</pre>
</p>
<p>This command defines the following actions for group CHICAGO:
</p>
<ol>
<li>Log the alert based on the ALRLOGSTS network attribute.
</li>
<li>Send the alert to this system's focal point.
</li>
<li>Send the alert to the system with control point name MILWKEE and a network id based on the LCLNETID value specified in the system network attributes.
</li>
<li>Place an alert notification on data queue ALERTDTAQ.
</li>
<li>Assign the alert to user CHICAGOOPR.
</li>
</ol>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDALRACNE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDALRACNE.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF2150</b></dt>
<dd>Object information function failed.
</dd>
<dt><b>CPF2151</b></dt>
<dd>Operation failed for &amp;2 in &amp;1 type *&amp;3.
</dd>
<dt><b>CPF812F</b></dt>
<dd>Filter damaged.
</dd>
<dt><b>CPF91DB</b></dt>
<dd>Group &amp;4 already exists.
</dd>
<dt><b>CPF91DE</b></dt>
<dd>Filter &amp;1/&amp;2 at maximum size.
</dd>
<dt><b>CPF91EB</b></dt>
<dd>Filter type &amp;3 not correct for this operation.
</dd>
<dt><b>CPF91EC</b></dt>
<dd>Internal processing error occurred.
</dd>
<dt><b>CPF91E8</b></dt>
<dd>Internal processing error occurred.
</dd>
<dt><b>CPF9802</b></dt>
<dd>Not authorized to object &amp;2 in &amp;3.
</dd>
<dt><b>CPF9803</b></dt>
<dd>Cannot allocate object &amp;2 in library &amp;3.
</dd>
<dt><b>CPF9807</b></dt>
<dd>One or more libraries in library list deleted.
</dd>
<dt><b>CPF9808</b></dt>
<dd>Cannot allocate one or more libraries on library list.
</dd>
<dt><b>CPF9830</b></dt>
<dd>Cannot assign library &amp;1.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDALRACNE.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>