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

570 lines
19 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>Run LPDA-2 (RUNLPDA)</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="RUNLPDA.Top_Of_Page"></a>
<h2>Run LPDA-2 (RUNLPDA)</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="#RUNLPDA.PARAMETERS.TABLE">Parameters</a><br>
<a href="#RUNLPDA.COMMAND.EXAMPLES">Examples</a><br>
<a href="#RUNLPDA.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="RUNLPDA"></a>
<p>The Run LPDA-2 (RUNLPDA) command allows you to run a Link Problem Determination Aid-2 (LPDA-2) operational command on local or remote data circuit-terminating equipment (DCE). The RUNLPDA command can be used to:
</p>
<ul>
<li>Establish or disconnect a switched telephone network connection.
</li>
<li>Open or close the relay contact in a coupler.
</li>
<li>Determine whether a relay contact is open or closed.
</li>
<li>Determine whether electric current is flowing through an internal sensor.
</li>
<li>Change the transmit speed of a DCE to full or backup.
</li>
</ul>
<p>The result of the RUNLPDA command is returned as a message.
</p>
<p><b>Restrictions:</b>
</p>
<ol>
<li>The RUNLPDA command is valid only for an analog LPDA-2 DCE attached to a nonswitched SDLC line.
</li>
<li>This command is shipped with public *EXCLUDE authority and the QPGMR, QSYSOPR, QSRV, or QSRVBAS, user profiles have private authorities to use the command.
</li>
</ol>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNLPDA.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="RUNLPDA.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="#RUNLPDA.LINE"><b>LINE</b></a></td>
<td valign="top">Line</td>
<td valign="top"><i>Name</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#RUNLPDA.OPTION"><b>OPTION</b></a></td>
<td valign="top">Option</td>
<td valign="top">*CALL, *DSC, *SETSPEED, *CONTSENSE, *CONTOPER</td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#RUNLPDA.LCLDCEADR"><b>LCLDCEADR</b></a></td>
<td valign="top">Local DCE address</td>
<td valign="top">01-FB, <b><u>*LCL</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RUNLPDA.RMTDCEADR"><b>RMTDCEADR</b></a></td>
<td valign="top">Remote DCE address</td>
<td valign="top">01-FB, <b><u>*NONE</u></b>, *ANY</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#RUNLPDA.TELNBR"><b>TELNBR</b></a></td>
<td valign="top">Telephone number</td>
<td valign="top">Single values: <b><u>*STORED</u></b><br>Other values: <i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Number 1</td>
<td valign="top">
<i>Character value</i></td>
</tr>
<tr>
<td valign="top">Element 2: Number 2</td>
<td valign="top">
<i>Character value</i></td>
</tr>
<tr>
<td valign="top"><a href="#RUNLPDA.CONTACT"><b>CONTACT</b></a></td>
<td valign="top">Relay contact</td>
<td valign="top">*OPEN, *CLOSE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RUNLPDA.SPEED"><b>SPEED</b></a></td>
<td valign="top">Transmit speed</td>
<td valign="top">*FULL, *BACKUP</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RUNLPDA.DTEPORT"><b>DTEPORT</b></a></td>
<td valign="top">DTE port</td>
<td valign="top"><b><u>*ALL</u></b>, A, B, C, D</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RUNLPDA.DCERTY"><b>DCERTY</b></a></td>
<td valign="top">DCE retry</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="#RUNLPDA.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="RUNLPDA.LINE"></a>
<h3>Line (LINE)</h3>
<p>Specifies the name of the nonswitched SDLC line that is attached to the analog DCE on which the LPDA-2 operational command is to be run. If *CALL is specified on the <b>Option</b> prompt (OPTION parameter), the line must be varied on but not active. If *CONTOPER, *CONTSENSE, *DSC, or *SETSPEED is specified on the OPTION parameter, the line must be either varied on or active.
</p>
<p>This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNLPDA.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNLPDA.OPTION"></a>
<h3>Option (OPTION)</h3>
<p>Specifies which LPDA-2 operational command is run.
</p>
<p>This is a required parameter.
</p>
<p>The contact operate, contact sense, and set transmit speed commands can be run on a local DCE or a remote DCE.
</p>
<p>To run one of these commands on a local DCE:
</p>
<ul>
<li>On the <b>Local DCE address</b> prompt (LCLDCEADR parameter), specify the address of the local DCE.
</li>
<li>On the <b>Remote DCE address</b> prompt (RMTDCEADR parameter), specify *NONE.
</li>
</ul>
<p>To run one of these commands on a remote DCE:
</p>
<ul>
<li>On the LCLDCEADR parameter, specify the address of the local DCE to which the remote DCE is connected.
</li>
<li>On the RMTDCEADR parameter, specify the address of the remote DCE.
</li>
</ul>
<p>
<b>Note: </b>If the local DCE is configured as point-to-point secondary or multipoint tributary, LPDA-2 commands are not sent to the remote DCE.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b>*CALL</b></dt>
<dd>The call out command is run. This command establishes a connection between a local and a remote DCE over a switched telephone network. This value is valid only if:
<ul>
<li>Both the local DCE and the remote DCE have two-wire couplers installed or both the local DCE and the remote DCE have four-wire couplers installed.
</li>
<li>The line specified on the <b>Line</b> prompt (LINE parameter) is varied on, but not active.
</li>
</ul>
</dd>
<dt><b>*CONTOPER</b></dt>
<dd>The contact operate command is run. This command opens or closes the relay contact in the coupler, depending on the value specified on the <b>Relay contact</b> prompt (CONTACT parameter). This value is valid only if a two-wire coupler is installed in the DCE on which this LPDA-2 command is run.
</dd>
<dt><b>*CONTSENSE</b></dt>
<dd>The contact sense command is run. This command reports whether the relay contact in the coupler is open or closed and whether electric current is flowing through the internal sensor. This option is valid only if a two-wire coupler is installed in the DCE on which this command is run.
</dd>
<dt><b>*DSC</b></dt>
<dd>The disconnect command is run. This command disconnects the switched telephone network connection between the local DCE and the remote DCE. If you specify this value, you cannot specify *NONE on the <b>Remote DCE address</b> prompt (RMTDCEADR parameter).
</dd>
<dt><b>*SETSPEED</b></dt>
<dd>The set transmit speed command is run. This command changes the transmit speed of the DCE to full or backup, depending on the value specified on the <b>Transmit speed</b> prompt (SPEED parameter). For multiple port DCE configurations in which the data terminal equipment (DTE) ports can be set to different speeds, use the <b>DTE port</b> prompt (DTEPORT parameter) to specify the port.
<p>
<b>Note: </b>The set transmit speed command may not change the transmit speed, depending on the configuration options selected for the DCE. Refer to the DCE documentation for more information.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNLPDA.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNLPDA.LCLDCEADR"></a>
<h3>Local DCE address (LCLDCEADR)</h3>
<p>Specifies the hexadecimal address of the local DCE. Refer to the DCE documentation for more information on addressing.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*LCL</u></b></dt>
<dd>X'01' is used for the address.
</dd>
<dt><b><i>local-DCE-address</i></b></dt>
<dd>Specify the address of the local DCE. Valid values range from X'01' through X'FB'.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNLPDA.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNLPDA.RMTDCEADR"></a>
<h3>Remote DCE address (RMTDCEADR)</h3>
<p>Specifies the hexadecimal address of the remote DCE on which the LPDA-2 operational command is to be run.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>X'00' is used as the address, which indicates that the LPDA-2 command is to be run on the local DCE. You cannot specify *NONE on this parameter if you specify *DSC on the <b>Option</b> prompt (OPTION parameter).
</dd>
<dt><b>*ANY</b></dt>
<dd>X'FD' is used for the address. Specify this value in the following situations:
<ul>
<li>The LPDA-2 command is to be run on any remote DCE connected to the local DCE.
</li>
<li>You do not know the remote DCE address on a point-to-point line.
</li>
<li>To run the LPDA-2 operational command on all tributary DCEs on a multipoint line. In this case, no detailed response is received.
</li>
</ul>
</dd>
<dt><b><i>remote-DCE-address</i></b></dt>
<dd>Specify the address of the remote DCE. Valid values range from X'01' through X'FB'.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNLPDA.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNLPDA.TELNBR"></a>
<h3>Telephone number (TELNBR)</h3>
<p>Specifies the telephone number or telephone numbers that the local DCE dials to establish a connection to the remote DCE. This parameter is valid only if *CALL is specified on the <b>Option</b> prompt (OPTION parameter).
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*STORED</u></b></dt>
<dd>The telephone number or numbers stored in the local DCE when the DCE was configured are used.
</dd>
<dt><b><i>telephone-number</i></b></dt>
<dd>Specify one telephone number if a two-wire coupler is installed in the local DCE. Specify two telephone numbers if a four-wire coupler is installed in the local DCE. Only numeric characters are processed by the LPDA-2 command, but you can also enter alphabetic characters or any other non-DBCS characters to improve readability. A comma (,) can be used to instruct the DCE to pause during dialing.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNLPDA.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNLPDA.CONTACT"></a>
<h3>Relay contact (CONTACT)</h3>
<p>Specifies whether to open or close the relay contact in a two-wire coupler. This parameter is required if *CONTOPER is specified on the <b>Option</b> prompt (OPTION parameter).
</p>
<p>The possible values are:
</p>
<dl>
<dt><b>*OPEN</b></dt>
<dd>The relay contact is opened.
</dd>
<dt><b>*CLOSE</b></dt>
<dd>The relay contact is closed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNLPDA.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNLPDA.SPEED"></a>
<h3>Transmit speed (SPEED)</h3>
<p>Specifies desired transmit speed of the DCE. This parameter is required if *SETSPEED is specified on the <b>Option</b> prompt (OPTION parameter).
</p>
<p>The possible values are:
</p>
<dl>
<dt><b>*FULL</b></dt>
<dd>The transmit speed is set to full.
</dd>
<dt><b>*BACKUP</b></dt>
<dd>The transmit speed is set to backup.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNLPDA.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNLPDA.DTEPORT"></a>
<h3>DTE port (DTEPORT)</h3>
<p>Specifies the DTE port on the local or remote DCE for which the transmit speed is changed. This parameter is valid only if *SETSPEED is specified on the <b>Option</b> prompt (OPTION parameter) and is applicable only to multiple port DCEs that do not use the multiple address configuration option.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>The aggregate speed of the DCE is changed. Refer to the DCE documentation for information on the effect of changing the aggregate speed on the transmit speed of individual ports.
</dd>
<dt><b>A</b></dt>
<dd>The transmit speed of the A-port is changed.
</dd>
<dt><b>B</b></dt>
<dd>The transmit speed of the B-port is changed.
</dd>
<dt><b>C</b></dt>
<dd>The transmit speed of the C-port is changed.
</dd>
<dt><b>D</b></dt>
<dd>The transmit speed of the D-port is changed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNLPDA.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RUNLPDA.DCERTY"></a>
<h3>DCE retry (DCERTY)</h3>
<p>Specifies whether the local DCE resends the LPDA-2 command to the remote DCE if no response is received from the remote DCE. No retry can be attempted if *CALL or *DSC is specified on the <b>Option</b> prompt (OPTION parameter).
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>No retry is attempted.
</dd>
<dt><b>*YES</b></dt>
<dd>One retry is attempted.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNLPDA.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RUNLPDA.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Establishing a Switched Telephone Network Connection</b>
</p>
<p>
<pre>
RUNLPDA LINE(SDLCLINE) OPTION(*CALL) LCLDCEADR(*LCL)
RMTDCEADR(*NONE) TELNBR(*STORED)
</pre>
</p>
<p>This command runs the call out command. The local DCE with address X'01' (*LCL) on line SDLCLINE dials the telephone numbers that are stored in the local DCE.
</p>
<p><b>Example 2: Establishing a Switched Telephone Network Connection</b>
</p>
<p>
<pre>
RUNLPDA LINE(SDLCLINE) OPTION(*CALL)
LCLDCEADR(*LCL) RMTDCEADR(*NONE)
TELNBR('9, 1-507-555-1212' '9, 1 (507) 555-1313')
</pre>
</p>
<p>This command runs the call out command. The local DCE dials the two numbers specified on the TELNBR parameter. The comma (,) indicates a pause during dialing. Other non-numeric characters are ignored, but are allowed for easier reading.
</p>
<p><b>Example 3: Disconnecting a Switched Telephone Network Connection</b>
</p>
<p>
<pre>
RUNLPDA LINE(SDLCLINE) OPTION(*DSC)
LCLDCEADR(10) RMTDCEADR(*ANY)
</pre>
</p>
<p>This command runs the disconnect command. The local DCE with address X'10' disconnects from the switched telephone network.
</p>
<p><b>Example 4: Closing the Relay Contact in the Local DCE</b>
</p>
<p>
<pre>
RUNLPDA LINE(SDLCLINE) OPTION(*CONTOPER) LCLDCEADR(02)
RMTDCEADR(*NONE) CONTACT(*CLOSE)
</pre>
</p>
<p>This command runs the contact operate command. The local DCE with address X'02' closes the relay contact in its two-wire coupler.
</p>
<p><b>Example 5: Reporting the Status of the Relay Contact</b>
</p>
<p>
<pre>
RUNLPDA LINE(SDLCLINE) OPTION(*CONTSENSE)
LCLDCEADR(01) RMTDCEADR(04)
</pre>
</p>
<p>This command runs the contact sense command. A message reports the status of the relay contact in the remote DCE with address X'04'. (The correct local DCE address must be specified on the LCLDCEADR parameter.)
</p>
<p><b>Example 6: Changing the Transmit Speed</b>
</p>
<p>
<pre>
RUNLPDA LINE(SDLCLINE) OPTION(*SETSPEED) LCLDCEADR(05)
RMTDCEADR(*NONE) SPEED(*BACKUP) DTEPORT(B)
</pre>
</p>
<p>This command runs the set transmit speed command. The transmit speed for Port B of the local DCE with address X'05' is changed to backup speed.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNLPDA.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RUNLPDA.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF1BAA</b></dt>
<dd>LPDA-2 command cannot run in switched network backup.
</dd>
<dt><b>CPF1BAB</b></dt>
<dd>LPDA-2 command not supported by target DCE.
</dd>
<dt><b>CPF1BAC</b></dt>
<dd>Required feature not installed.
</dd>
<dt><b>CPF1BAD</b></dt>
<dd>LPDA-2 command not compatible with DCE configuration.
</dd>
<dt><b>CPF1BA1</b></dt>
<dd>Line description &amp;1 does not exist.
</dd>
<dt><b>CPF1BA2</b></dt>
<dd>Line &amp;1 not active or not varied on.
</dd>
<dt><b>CPF1BA3</b></dt>
<dd>Line &amp;1 is active secondary.
</dd>
<dt><b>CPF1BA4</b></dt>
<dd>Line &amp;1 failed while processing RUNLPDA.
</dd>
<dt><b>CPF1BA5</b></dt>
<dd>No response received for LPDA-2 command.
</dd>
<dt><b>CPF1BA6</b></dt>
<dd>Cannot run LPDA-2 command on line &amp;1.
</dd>
<dt><b>CPF1BA7</b></dt>
<dd>No buffers available for RUNLPDA data.
</dd>
<dt><b>CPF1BA8</b></dt>
<dd>LPDA-2 command already active on line &amp;1.
</dd>
<dt><b>CPF1BBA</b></dt>
<dd>Continuous answer tone received for first call.
</dd>
<dt><b>CPF1BBB</b></dt>
<dd>Continuous answer tone received for second call.
</dd>
<dt><b>CPF1BBC</b></dt>
<dd>No line signal on switched connection.
</dd>
<dt><b>CPF1BBD</b></dt>
<dd>No initial dial tone.
</dd>
<dt><b>CPF1BBE</b></dt>
<dd>No dial tone after pause.
</dd>
<dt><b>CPF1BBF</b></dt>
<dd>Busy tone received from remote DCE.
</dd>
<dt><b>CPF1BB0</b></dt>
<dd>Coupler not installed in local DCE.
</dd>
<dt><b>CPF1BB1</b></dt>
<dd>Coupler not operational.
</dd>
<dt><b>CPF1BB2</b></dt>
<dd>LPDA-2 command not valid with configuration options.
</dd>
<dt><b>CPF1BB3</b></dt>
<dd>Telephone number not valid.
</dd>
<dt><b>CPF1BB5</b></dt>
<dd>Switched connection already active.
</dd>
<dt><b>CPF1BB6</b></dt>
<dd>Only single telephone number allowed.
</dd>
<dt><b>CPF1BB7</b></dt>
<dd>Two telephone numbers required.
</dd>
<dt><b>CPF1BB8</b></dt>
<dd>No answer from remote DCE on first call.
</dd>
<dt><b>CPF1BB9</b></dt>
<dd>No answer from remote DCE on second call.
</dd>
<dt><b>CPF1BDA</b></dt>
<dd>Error occurred processing RUNLPDA command.
</dd>
<dt><b>CPF1BDB</b></dt>
<dd>Internal processing error.
</dd>
<dt><b>CPF1BDC</b></dt>
<dd>Required feature not operational.
</dd>
<dt><b>CPF1BDD</b></dt>
<dd>Ring back limit exceeded.
</dd>
<dt><b>CPF1BDE</b></dt>
<dd>DCE busy. LPDA-2 command cannot be run.
</dd>
<dt><b>CPF1BDF</b></dt>
<dd>Line not in proper state for LPDA-2 call out command.
</dd>
<dt><b>CPF1BD3</b></dt>
<dd>DCE currently processing previous LPDA-2 command.
</dd>
<dt><b>CPF1BD5</b></dt>
<dd>Cannot send command to remote DCE.
</dd>
<dt><b>CPF1BD6</b></dt>
<dd>Line description &amp;1 not nonswitched *SDLC.
</dd>
<dt><b>CPF1BD8</b></dt>
<dd>Request failed. System service tools active.
</dd>
<dt><b>CPF1BD9</b></dt>
<dd>RUNLPDA command does not support switched lines.
</dd>
<dt><b>CPF1B85</b></dt>
<dd>Two-wire coupler not installed.
</dd>
<dt><b>CPF1B86</b></dt>
<dd>Coupler not installed.
</dd>
<dt><b>CPF1B87</b></dt>
<dd>Transmit speed cannot be changed.
</dd>
<dt><b>CPF1B88</b></dt>
<dd>DTE port selected not valid for configuration.
</dd>
<dt><b>CPF1B94</b></dt>
<dd>Local DCE received no response from remote DCE.
</dd>
<dt><b>CPF1B95</b></dt>
<dd>Not authorized to line description &amp;1.
</dd>
<dt><b>CPF1B97</b></dt>
<dd>Format of response received not valid.
</dd>
<dt><b>CPF1B98</b></dt>
<dd>Received response with bad frame check sequence.
</dd>
<dt><b>OFC8DB7</b></dt>
<dd>Internal processing failure.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RUNLPDA.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>