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

825 lines
21 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">
<title>Vary Configruation exit points</title>
<!-- 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. -->
<!-- Begin Header records -->
<!-- XDCVRX400.htm created by Mary Stadnick,825168 on Thu Jul 25 2002 -->
<!-- Changed: 040302 by JAHARRIS - added WTGT,NWSH new NWSD,NWSH types-->
<!--End Header Records ================================================ -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link =================================================== -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>Vary Configuration exit programs</h2>
<div class="box" style="width: 65%;">
<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%">Vary information</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">2</td>
<td align="left" valign="top">Return code</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">BIN(4)</td>
</tr>
</table>
<pre>
Exit Point Name: QIBM_QDC_VRYEXIT
Exit Point Format Name: PRON0100
Exit Point Format Name: PROF0100
QSYSINC Member Name: EDCVARY
</pre>
</div>
<br>
<div class="box" style="width: 65%;">
&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%">Vary information</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
</table>
<pre>
Exit Point Name: QIBM_QDC_VRYEXIT
Exit Point Format Name: PSON0200
Exit Point Format Name: PSOF0200
QSYSINC Member Name: EDCVARY
</pre>
</div>
<p>The QIBM_QDC_VRYEXIT exit point is defined to run all exit programs for
which the program data indicates the object type and configuration type match
the object being varied on. This exit point supports an unlimited number of
exit programs.</p>
<p><strong>Notes:</strong></p>
<ol>
<li>The vary configuration exit points ignore any error messages that are sent
from the user exit program.</li>
<li>It is strongly recommended that the exit program reside within the system
base or a user ASP.</li>
<li>When a forced vary off has been issued the exit program's ability to reject
the vary off processing is revoked and all user exit programs will be
executed.</li>
<li>When a vary request is made for a NWSD server connection type of *WINDOWSNT, *IXSVR,
or *ISCSI the ability to reject the vary request is revoked and all user exit
programs will be executed.</li>
<li>When an Auxiliary Storage Pool (ASP) device that is part of a group is
passed to the vary configuration (VRYCFG) command all ASP devices that are part
of the group are varied, but the exit programs registered for an ASP device
will be called only once for all ASPs in the group. The name of the object
passed to the exit program in the object name field of the format will be the
name of the object passed to the vary configuration command.</li>
<li>If a preprocesing exit program rejects a vary on/off process any subsequent
preprocessing programs will not be invoked, unless the forced vary off option
is selected.</li>
<li>If a preprocessing exit program rejects a vary on/off process all post
processing exit programs will be invoked.</li>
<li>Exit program processing is not supported for IPL online processing.</li>
<li>Exit program processing is not supported for the console controller.</li>
<li>Exit program processing is not supported for the console device.</li>
<li>Exit program processing is not supported for auto configuration
processing.</li>
<li>Exit program processing is not supported for Power Down System
(PWRDWNSYS).</li>
<li>Exit program processing is not supported for vary requests made under
system profiles.</li>
<li>Exit program processing is not supported for vary request made from system
jobs.</li>
</ol>
<br>
<h3>Authorities and Locks</h3>
<p>The user must have *ALLOBJ to add or remove exit programs to the
registration facility.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Vary information</strong></dt>
<dd>Input; CHAR(*)
<p>The vary information associated with the current vary request. The format of
the vary information is defined by the format name.</p>
</dd>
<dt><strong>Return code</strong></dt>
<dd>Output; BINARY(4)
<p>The return value from the user exit program. If an undefined return code is
returned, then the exit point will treat the return code as if it were 0.</p>
<table cellpadding="2">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">Continue vary processing.</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Reject vary processing.</td>
</tr>
</table>
</dd>
</dl>
<h3>Vary Information formats</h3>
<p><strong>PRON0100 and PROF0100 Formats</strong></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="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%">Object name</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">Object type</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Format name</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Forced vary</td>
</tr>
</table>
<br>
<p><strong>PSON0200 and PSOF0200 Formats</strong></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="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%">Object name</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">Object type</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Format name</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Status</td>
</tr>
</table>
<br>
<br>
<h3>Field Descriptons</h3>
<p><strong>Format name.</strong> The user exit format name being used. For
QIBM_QDC_VRYEXIT, the format name is one of the following:</p>
<table cellpadding="4">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>PRON0100</em></td>
<td valign="top">The exit point programs are called prior to the object being
varied on. This format can issue a return code value with the ability to reject
the vary processing.</td>
</tr>
<tr>
<td valign="top"><em>PSON0200</em></td>
<td valign="top">The exit point programs are called after the object vary on
has started.</td>
</tr>
<tr>
<td valign="top"><em>PROF0100</em></td>
<td valign="top">The exit point programs are called prior to the object being
varied off. This format can issue a return code value with the ability to
reject the vary processing.</td>
</tr>
<tr>
<td valign="top"><em>PSOF0200</em></td>
<td valign="top">The exit point programs are called after the object vary off
has started.</td>
</tr>
</table>
<p><strong>Forced vary.</strong> The field to indicate to the user exit program
that a forced vary off is occurring.</p>
<table cellpadding="2">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">Not forced vary off processing.</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Forced vary off processing.</td>
</tr>
</table>
<p><strong>Object name.</strong> The name of the object being processed by the
vary configuration command (VRYCFG).</p>
<p><strong>Object type.</strong> The type of object the exit program should be
executed against. The following values are supported:</p>
<table cellpadding="4">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*DEVD</em></td>
<td align="left" valign="top">The object type is a device description</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CTLD</em></td>
<td align="left" valign="top">The object type is a controller description</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIND</em></td>
<td align="left" valign="top">The object type is a line description</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NWSD</em></td>
<td align="left" valign="top">The object type is a network server
description</td>
</tr>
</table>
<p><strong>Status.</strong> The field value indicating if a preprocessing exit
program rejected the vary request or the vary request was not successful.</p>
<table cellpadding="2">
<!-- cols="15 85" -->
<tr>
<td valign="top"><em>0</em></td>
<td valign="top">Vary request was successful.</td>
</tr>
<tr>
<td valign="top"><em>1</em></td>
<td valign="top">Vary request was not successful.</td>
</tr>
<tr>
<td valign="top"><em>2</em></td>
<td valign="top">Vary request was rejected by a preprocessing exit
program.</td>
</tr>
<tr>
<td valign="top"><em>3</em></td>
<td valign="top">Status of vary request is unknown.</td>
</tr>
</table>
<p><strong>Program Data.</strong> When registering the exit program 8
characters of program data must be passed. The first 4 characters are the
object type and the remaining 4 characters should be the object configuration
type.</p>
<table width="80%" border>
<tr>
<th align="left" valign="BOTTOM" rowspan="1">Characters</th>
<th align="left" valign="BOTTOM" rowspan="1">Value</th>
<th align="left" valign="BOTTOM" rowspan="1">Description</th>
</tr>
<tr>
<td align="left" valign="top" width="20%">Characters 1 through 4</td>
<td align="left" valign="top" width="20%">Object type</td>
<td align="left" valign="top" width="60%">The object type the exit program
should be executed for:
<p><strong>Note:</strong> The object type value specified must be in all
uppercase.</p>
<table cellpadding="4">
<tr>
<td valign="top"><em>DEVD</em></td>
<td valign="top">The object type is a device description</td>
</tr>
<tr>
<td valign="top"><em>CTLD</em></td>
<td valign="top">The object type is a controller description</td>
</tr>
<tr>
<td valign="top"><em>LIND</em></td>
<td valign="top">The object type is a line description</td>
</tr>
<tr>
<td valign="top"><em>NWSD</em></td>
<td valign="top">The object type is a network server description</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top">Characters 5 through 8</td>
<td align="left" valign="top">Configuration type</td>
<td align="left" valign="top">See tables below for valid
values</td>
</tr>
</table>
<p><strong>Note:</strong> The configuration type value is dependent on the
value specified for the object type.</p>
<table width="80%" border>
<tr>
<td align="center" valign="BOTTOM" colspan="2" rowspan="1"><strong>Supported
configuration types for object type DEVD</strong></td>
</tr>
<tr>
<th align="left" valign="BOTTOM" colspan="1">Configuration type</th>
<th align="left" valign="BOTTOM" rowspan="1">Description</th>
</tr>
<tr>
<td align="left" valign="top" width="25%">DSKT</td>
<td align="left" valign="top" width="80%">Diskette unit (DKT) device
description</td>
</tr>
<tr>
<td align="left" valign="top">TAPE</td>
<td align="left" valign="top">Tape (TAP) device description</td>
</tr>
<tr>
<td align="left" valign="top">DSPL</td>
<td align="left" valign="top">Local display (DSP) description</td>
</tr>
<tr>
<td align="left" valign="top">DSPR</td>
<td align="left" valign="top">Remote display (DSP) description</td>
</tr>
<tr>
<td align="left" valign="top">PRTL</td>
<td align="left" valign="top">Local printer (PRT) description</td>
</tr>
<tr>
<td align="left" valign="top">PRTR</td>
<td align="left" valign="top">Remote printer (PRT) description</td>
</tr>
<tr>
<td align="left" valign="top">FINC</td>
<td align="left" valign="top">Finance (FNC) device description</td>
</tr>
<tr>
<td align="left" valign="top">APPC</td>
<td align="left" valign="top">Advanced program-to-program communications (APPC)
device description</td>
</tr>
<tr>
<td align="left" valign="top">ASYN</td>
<td align="left" valign="top">Asynchronous (ASYNC) device description</td>
</tr>
<tr>
<td align="left" valign="top">BISC</td>
<td align="left" valign="top">Binary synchronous communications (BSC) device
description</td>
</tr>
<tr>
<td align="left" valign="top">HOST</td>
<td align="left" valign="top">Systems network architecture (SNA) host device
description</td>
</tr>
<tr>
<td align="left" valign="top">SNUF</td>
<td align="left" valign="top">Systems network architecture upline facility
(SNUF) device description</td>
</tr>
<tr>
<td align="left" valign="top">DSPV</td>
<td align="left" valign="top">Virtual display (DSP) device description</td>
</tr>
<tr>
<td align="left" valign="top">PRTV</td>
<td align="left" valign="top">Virtual printer (PRT) device description</td>
</tr>
<tr>
<td align="left" valign="top">INTR</td>
<td align="left" valign="top">Intrasystem (INTRA) device description</td>
</tr>
<tr>
<td align="left" valign="top">RETL</td>
<td align="left" valign="top">Retail (RTL) device description</td>
</tr>
<tr>
<td align="left" valign="top">NTWK</td>
<td align="left" valign="top">Network (NET) device description</td>
</tr>
<tr>
<td align="left" valign="top">SNPU</td>
<td align="left" valign="top">Upstream SNA pass-through (SNPT) device
description</td>
</tr>
<tr>
<td align="left" valign="top">SNPD</td>
<td align="left" valign="top">Downstream SNA pass-through (SNPT) device
description</td>
</tr>
<tr>
<td align="left" valign="top">DSPS</td>
<td align="left" valign="top">SNA pass-through display (DSP) device
description</td>
</tr>
<tr>
<td align="left" valign="top">PRTS</td>
<td align="left" valign="top">SNA pass-through printer (PRT) device
description</td>
</tr>
<tr>
<td align="left" valign="top">FNCS</td>
<td align="left" valign="top">SNA pass-through finance (FNC) device
description</td>
</tr>
<tr>
<td align="left" valign="top">RTLS</td>
<td align="left" valign="top">SNA pass-through retail (RTL) device
description</td>
</tr>
<tr>
<td align="left" valign="top">PRTN</td>
<td align="left" valign="top">Local area network printer (PRT) device
description</td>
</tr>
<tr>
<td align="left" valign="top">OMLB</td>
<td align="left" valign="top">Optical media libray (MLB) device
description</td>
</tr>
<tr>
<td align="left" valign="top">OPTD</td>
<td align="left" valign="top">Optical (OPT) device description</td>
</tr>
<tr>
<td align="left" valign="top">TMLB</td>
<td align="left" valign="top">Tape media libray (MLB) device description</td>
</tr>
<tr>
<td align="left" valign="top">CRPD</td>
<td align="left" valign="top">Crypto (CRP) device description</td>
</tr>
<tr>
<td align="left" valign="top">ASPD</td>
<td align="left" valign="top">Auxilliary storage pool (ASP) device
description</td>
</tr>
<tr>
<td align="left" valign="top"><img src="delta.gif" alt="Start of change">NWSH</td>
<td align="left" valign="top">Network server host adapter(NWSH) device
description<img src="deltaend.gif" alt="End of change"></td>
</tr>
</table>
<br>
<table width="80%" border>
<tr>
<td align="center" valign="BOTTOM" colspan="2" rowspan="1"><strong>Supported
configuration types for object type CTLD</strong></td>
</tr>
<tr>
<th align="left" valign="BOTTOM" colspan="1">Configuration type</th>
<th align="left" valign="BOTTOM" rowspan="1">Description</th>
</tr>
<tr>
<td align="left" valign="top" width="25%">LCLW</td>
<td align="left" valign="top" width="75%">Local workstation (LWS) controller
description</td>
</tr>
<tr>
<td align="left" valign="top">VRTW</td>
<td align="left" valign="top">Virtual workstation (VWS) controller
description</td>
</tr>
<tr>
<td align="left" valign="top">RMTW</td>
<td align="left" valign="top">Remote workstation (RWS) controller
description</td>
</tr>
<tr>
<td align="left" valign="top">FINC</td>
<td align="left" valign="top">Finance (FNC) controller description</td>
</tr>
<tr>
<td align="left" valign="top">APPC</td>
<td align="left" valign="top">Advanced program-to-program communications (APPC)
controller description</td>
</tr>
<tr>
<td align="left" valign="top">HOST</td>
<td align="left" valign="top">Systems network architecture (SNA) host
controller description</td>
</tr>
<tr>
<td align="left" valign="top">BISC</td>
<td align="left" valign="top">Binary synchronous communications (BSC)
controller description</td>
</tr>
<tr>
<td align="left" valign="top">ASYN</td>
<td align="left" valign="top">Asynchronous (ASYNC) controller description</td>
</tr>
<tr>
<td align="left" valign="top">TAPE</td>
<td align="left" valign="top">Tape (TAP) controller description</td>
</tr>
<tr>
<td align="left" valign="top">RETL</td>
<td align="left" valign="top">Retail (RTL) controller description</td>
</tr>
<tr>
<td align="left" valign="top">NTWK</td>
<td align="left" valign="top">Network (NET) controller description</td>
</tr>
</table>
<br>
<table width="80%" border>
<tr>
<td align="center" valign="BOTTOM" colspan="2" rowspan="1"><strong>Supported
configuration types for object type LIND</strong></td>
</tr>
<tr>
<th align="left" valign="BOTTOM" colspan="1">Configuration type</th>
<th align="left" valign="BOTTOM" rowspan="1">Description</th>
</tr>
<tr>
<td align="left" valign="top" width="25%">SDLC</td>
<td align="left" valign="top" width="75%">Synchronous data link control (SDLC)
line description</td>
</tr>
<tr>
<td align="left" valign="top">BISC</td>
<td align="left" valign="top">Binary synchronous communications (BSC) line
description</td>
</tr>
<tr>
<td align="left" valign="top">ASYN</td>
<td align="left" valign="top">Asynchronous (ASYNC) line description</td>
</tr>
<tr>
<td align="left" valign="top">X25L</td>
<td align="left" valign="top">X.25 (X25) line description</td>
</tr>
<tr>
<td align="left" valign="top">TKRN</td>
<td align="left" valign="top">Token ring network (TRN) line description</td>
</tr>
<tr>
<td align="left" valign="top">TDLC</td>
<td align="left" valign="top">Twinaxial data link control (TDLC) line
description</td>
</tr>
<tr>
<td align="left" valign="top">ETHN</td>
<td align="left" valign="top">Ethernet (ETH) line description</td>
</tr>
<tr>
<td align="left" valign="top">WLSL</td>
<td align="left" valign="top">Wireless local area network (WLS) line
description</td>
</tr>
<tr>
<td align="left" valign="top">PPPL</td>
<td align="left" valign="top">Point-to-Point Protocol (PPP) line
description</td>
</tr>
<tr>
<td align="left" valign="top">DDIL</td>
<td align="left" valign="top">Data-description interface (DDI) line
description</td>
</tr>
<tr>
<td align="left" valign="top">FRNW</td>
<td align="left" valign="top">Frame-relay network (FR) line description</td>
</tr>
<tr>
<td align="left" valign="top">FAXL</td>
<td align="left" valign="top">Facsimile (FAX) line description</td>
</tr>
</table>
<br>
<table width="80%" border>
<tr>
<td align="center" valign="BOTTOM" colspan="2" rowspan="1"><strong>Supported
configuration types for object type NWSD</strong></td>
</tr>
<tr>
<th align="left" valign="BOTTOM" colspan="1">Configuration type</th>
<th align="left" valign="BOTTOM" rowspan="1">Description</th>
</tr>
<tr>
<td align="left" valign="top" width="25%">IXSV</td>
<td align="left" valign="top" width="75%">Integrated network server description of server
<p>Supports NWSD objects of server connection type *WINDOWSNT and *IXSVR</td>
</tr>
<tr>
<td align="left" valign="top"><img src="delta.gif" alt="Start of change">GTOS</td>
<td align="left" valign="top">Guest operating system network server description
<p>Supports NWSD objects of server connection type *GUEST</td>
</tr>
<tr>
<td align="left" valign="top">ISCS</td>
<td align="left" valign="top">iSCSI network server description
Supports NWSD objects of server connection type *ISCS</td>
</tr>
</table>
<p><strong>Notes:</strong></p>
<p>
For compatibility purposes user exit programs registered in V5R3 with NWSD configuration type WDNT will be processed as if IXSV had been specified.
<img src="deltaend.gif" alt="End of change"></p>
<br>
<br>
<hr>
Exit program introduced: V5R3
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"config.htm">Configuration APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
</body>
</html>