226 lines
9.9 KiB
HTML
226 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">
|
||
|
|
<title>Retrieve Configuration Status (RTVCFGSTS)</title>
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body bgcolor="white">
|
||
|
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<a name="RTVCFGSTS.Top_Of_Page"></a>
|
||
|
|
<h2>Retrieve Configuration Status (RTVCFGSTS)</h2>
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td valign="top" align="left"><b>Where allowed to run: </b>Compiled CL program or interpreted REXX (*BPGM *IPGM *BREXX *IREXX)<br>
|
||
|
|
<b>Threadsafe: </b>No
|
||
|
|
</td>
|
||
|
|
<td valign="top" align="right">
|
||
|
|
<a href="#RTVCFGSTS.PARAMETERS.TABLE">Parameters</a><br>
|
||
|
|
<a href="#RTVCFGSTS.COMMAND.EXAMPLES">Examples</a><br>
|
||
|
|
<a href="#RTVCFGSTS.ERROR.MESSAGES">Error messages</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<div> <a name="RTVCFGSTS"></a>
|
||
|
|
<p>The Retrieve Configuration Status (RTVCFGSTS) command provides a CL program with a numeric value that represents the status of a configuration object.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVCFGSTS.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<hr size="2" width="100%">
|
||
|
|
|
||
|
|
<div>
|
||
|
|
<h3><a name="RTVCFGSTS.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"><a href="#RTVCFGSTS.CFGD"><b>CFGD</b></a></td>
|
||
|
|
<td valign="top">Configuration description</td>
|
||
|
|
<td valign="top"><i>Name</i></td>
|
||
|
|
<td valign="top">Required, Positional 1</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVCFGSTS.CFGTYPE"><b>CFGTYPE</b></a></td>
|
||
|
|
<td valign="top">Type</td>
|
||
|
|
<td valign="top">*NWI, *NWS, *LIN, *CTL, *DEV</td>
|
||
|
|
<td valign="top">Required, Positional 2</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#RTVCFGSTS.STSCDE"><b>STSCDE</b></a></td>
|
||
|
|
<td valign="top">CL variable for status code</td>
|
||
|
|
<td valign="top"><i>Decimal number</i></td>
|
||
|
|
<td valign="top">Required, Positional 3</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVCFGSTS.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div> <a name="RTVCFGSTS.CFGD"></a>
|
||
|
|
<h3>Configuration description (CFGD)</h3>
|
||
|
|
<p>Specifies the name of the configuration description for which the status will be retrieved.
|
||
|
|
</p>
|
||
|
|
<p>This is a required parameter.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVCFGSTS.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVCFGSTS.CFGTYPE"></a>
|
||
|
|
<h3>Type (CFGTYPE)</h3>
|
||
|
|
<p>Specifies the type of description for which you want to retrieve status.
|
||
|
|
</p>
|
||
|
|
<dl>
|
||
|
|
<dt><b>*NWS</b></dt>
|
||
|
|
<dd>The object is a network server description.
|
||
|
|
</dd>
|
||
|
|
<dt><b>*NWI</b></dt>
|
||
|
|
<dd>Status for a network interface is retrieved.
|
||
|
|
</dd>
|
||
|
|
<dt><b>*LIN</b></dt>
|
||
|
|
<dd>Status for a line is retrieved.
|
||
|
|
</dd>
|
||
|
|
<dt><b>*CTL</b></dt>
|
||
|
|
<dd>Status for a controller is retrieved.
|
||
|
|
</dd>
|
||
|
|
<dt><b>*DEV</b></dt>
|
||
|
|
<dd>Status for a device is retrieved.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<p>This is a required parameter.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVCFGSTS.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="RTVCFGSTS.STSCDE"></a>
|
||
|
|
<h3>CL variable for status code (STSCDE)</h3>
|
||
|
|
<p>Specifies the name of a variable which will contain the retrieved status. In a CL program, this should be a decimal variable of length (5 0).
|
||
|
|
</p>
|
||
|
|
<p>The possible values which can be returned are:
|
||
|
|
</p>
|
||
|
|
<dl>
|
||
|
|
<dt><b>Value</b></dt>
|
||
|
|
<dd><b> Definition
|
||
|
|
</b></dd>
|
||
|
|
<dt><b>0</b></dt>
|
||
|
|
<dd>VARIED OFF - The system is not using the description.
|
||
|
|
</dd>
|
||
|
|
<dt><b>10</b></dt>
|
||
|
|
<dd>VARY OFF PENDING - The description is being varied off. During this time the system may be taking down the tasks which managed the resource, and so on.
|
||
|
|
</dd>
|
||
|
|
<dt><b>20</b></dt>
|
||
|
|
<dd>VARY ON PENDING - The description is being varied on. During this time the system may be putting tasks in place to manage the resource, downloading a program to an I/O processor, communicating with data circuit-terminating equipment (DCE), and so on.
|
||
|
|
</dd>
|
||
|
|
<dt><b>30</b></dt>
|
||
|
|
<dd>VARIED ON - The tasks that manage the network interface, network server, line, controller, or device have been put in place by the system, and the system has the capability to communicate with it.
|
||
|
|
</dd>
|
||
|
|
<dt><b>32</b></dt>
|
||
|
|
<dd>VARY ON/CNN PENDING - The first of a pair of OptiConnect controllers is varied on but its attached device is not yet in a varied on state.
|
||
|
|
</dd>
|
||
|
|
<dt><b>40</b></dt>
|
||
|
|
<dd>CONNECT PENDING - This status is only valid for switched SDLC, IDLC, BSC, or asynchronous lines. The line is in this status while waiting for the switched connection to be established; this can be either a dial or an answer connection.
|
||
|
|
</dd>
|
||
|
|
<dt><b>50</b></dt>
|
||
|
|
<dd>SIGNON DISPLAY - This status is only valid for display devices. The system is preparing the device to receive the sign-on display, or sending the sign-on display, or the actual sign-on display is at the display station.
|
||
|
|
</dd>
|
||
|
|
<dt><b>51</b></dt>
|
||
|
|
<dd>ACTIVE/CNN PENDING - The first of a pair of OptiConnect controllers and its attached device are varied on and waiting for the OptiConnect path to be established.
|
||
|
|
</dd>
|
||
|
|
<dt><b>60</b></dt>
|
||
|
|
<dd>ACTIVE - The object is successfully placed in VARIED ON status. In addition: for network interfaces and the network servers, one or more attached lines is in a VARY ON PENDING status or higher; for lines, one or more attached controllers is in a VARY ON PENDING status or higher; for controllers, one or more attached devices is in a VARY ON PENDING status or higher; for devices, active status varies depending on the type of device -- more information is in the Communications Configuration book, SC41-5401 book. A display device which is at a second sign-on display as a result of pressing the system request key will be considered ACTIVE.
|
||
|
|
</dd>
|
||
|
|
<dt><b>63</b></dt>
|
||
|
|
<dd>ACTIVE READER - The device is in use by a spool reader.
|
||
|
|
</dd>
|
||
|
|
<dt><b>66</b></dt>
|
||
|
|
<dd>ACTIVE WRITER - The device is in use by a spool writer.
|
||
|
|
</dd>
|
||
|
|
<dt><b>67</b></dt>
|
||
|
|
<dd>AVAILABLE - The independent auxiliary storage pool (ASP) device is available for use without function restrictions.
|
||
|
|
</dd>
|
||
|
|
<dt><b>70</b></dt>
|
||
|
|
<dd>HELD - This status is only valid for Device Descriptions. The user or the system held the communications device to prevent it from communicating. The Release Communications Device (RLSCMNDEV) command can be used to release the device.
|
||
|
|
</dd>
|
||
|
|
<dt><b>80</b></dt>
|
||
|
|
<dd>RCYPND - Error recovery is pending for the line, controller, or device. A message indicating what error occurred appears on the QSYSOPR message queue.
|
||
|
|
</dd>
|
||
|
|
<dt><b>90</b></dt>
|
||
|
|
<dd>RCYCNL - Error recovery is canceled for the network interface, line, controller, or device. An error occurred, and the operator replied with a C (to cancel error recovery) to a message, or the operator used a command (ENDNWIRCY, ENDLINRCY, ENDCTLRCY, ENDDEVRCY) to end error recovery.
|
||
|
|
</dd>
|
||
|
|
<dt><b>95</b></dt>
|
||
|
|
<dd>SYSTEM REQUEST - The display device has been requested by the system and its associated job has been suspended. This occurs as a result of a user pressing the System Request key.
|
||
|
|
</dd>
|
||
|
|
<dt><b>100</b></dt>
|
||
|
|
<dd>FAILED - An error occurred for the network interface, network server, line, controller, or device that can be recovered only by varying off and on again.
|
||
|
|
</dd>
|
||
|
|
<dt><b>103</b></dt>
|
||
|
|
<dd>FAILED READER - An error occurred for the device while in use by a spool reader.
|
||
|
|
</dd>
|
||
|
|
<dt><b>106</b></dt>
|
||
|
|
<dd>FAILED WRITER - An error occurred for the device while in use by a spool writer.
|
||
|
|
</dd>
|
||
|
|
<dt><b>107</b></dt>
|
||
|
|
<dd>SHUTDOWN - The NWSD was shut down using an Application Program Interface (API).
|
||
|
|
</dd>
|
||
|
|
<dt><b>110</b></dt>
|
||
|
|
<dd>DIAGNOSTIC MODE - The network interface, network server, line, controller, or device resource is being used by problem analysis procedures to diagnose problems, and the resource cannot be used by other users.
|
||
|
|
</dd>
|
||
|
|
<dt><b>111</b></dt>
|
||
|
|
<dd>DAMAGED - The network interface, network server, line, controller, or device description is damaged. This is a system error condition. Information indicating when this damage occurred appears in the history log (QHST). Further information may be in the vertical licensed internal code (VLIC) logs. The description must be deleted and created once more before it can be used again.
|
||
|
|
</dd>
|
||
|
|
<dt><b>112</b></dt>
|
||
|
|
<dd>LOCKED - The actual status of the resource cannot be determined because another job has an exclusive lock on the description. Retry at a later time, or use the Work With Object Lock (WRKOBJLCK) command to determine which job has the lock on the description.
|
||
|
|
</dd>
|
||
|
|
<dt><b>113</b></dt>
|
||
|
|
<dd>UNKNOWN - The status indicator of the description cannot be determined. This is a system error condition. Use the Dump Object (DMPOBJ) command to dump the contents or attributes of the description to a spooled printer file, and contact your IBM representative.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<p>This is a required parameter.
|
||
|
|
</p>
|
||
|
|
<p>More information is in the Communications Configuration book, SC41-5401.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVCFGSTS.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<hr size="2" width="100%">
|
||
|
|
<div><h3><a name="RTVCFGSTS.COMMAND.EXAMPLES">Examples</a> </h3>
|
||
|
|
<p>
|
||
|
|
<pre>
|
||
|
|
RTVCFGSTS CFGD(ND01) CFGTYPE(*LIN) STSCDE(&STSCODE)
|
||
|
|
</pre>
|
||
|
|
</p>
|
||
|
|
<p>This command retrieves the configuration status of the line configuration description ND01 for use in the CL variable &STSCODE.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVCFGSTS.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<hr size="2" width="100%">
|
||
|
|
<div><h3><a name="RTVCFGSTS.ERROR.MESSAGES">Error messages</a> </h3>
|
||
|
|
<p><b><u>*ESCAPE Messages</u></b>
|
||
|
|
</p>
|
||
|
|
<dl>
|
||
|
|
<dt><b>CPF9801</b></dt>
|
||
|
|
<dd>Object &2 in library &3 not found.
|
||
|
|
</dd>
|
||
|
|
<dt><b>CPF9802</b></dt>
|
||
|
|
<dd>Not authorized to object &2 in &3.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#RTVCFGSTS.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|