202 lines
5.9 KiB
HTML
202 lines
5.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">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<title>Start DASD Management Session (QYASSDMS) 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. -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- File cleanup completed Oct 2001 by v2cdijab -->
|
||
|
|
<!-- 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>Start DASD Management Session (QYASSDMS) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 70%;">
|
||
|
|
<br>
|
||
|
|
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%">Session handle</td>
|
||
|
|
<td align="left" valign="top" width="20%">Output</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</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>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Start DASD Management Session (QYASSDMS) API activates an exclusive
|
||
|
|
session to the server. Only one session can be active at any time.</p>
|
||
|
|
|
||
|
|
<p>On successful completion of this API, a handle is returned. This handle is
|
||
|
|
used on subsequent calls to the following APIs:</p>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dd>Start DASD Management Operation (QYASSDMO)</dd>
|
||
|
|
|
||
|
|
<dd>End DASD Management Operation (QYASEDMO)</dd>
|
||
|
|
|
||
|
|
<dd>End DASD Management Session (QYASEDMS)</dd>
|
||
|
|
|
||
|
|
<dd>Retrieve DASD Management Status (QYASRDMS)</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<p>Upon successfully starting a disk management session, the session remains
|
||
|
|
active until either the session is explicitly ended using the End DASD
|
||
|
|
Management Session (QYASEDMS) API or at least five minutes of no session
|
||
|
|
activity has occurred and another request to either start a disk management
|
||
|
|
session or to start DST has been made. If this second event occurs, the
|
||
|
|
original session is ended automatically, its session handle is invalidated, and
|
||
|
|
a new session is started for the requesting caller; also, a new session handle
|
||
|
|
is generated.</p>
|
||
|
|
|
||
|
|
<p>Each time a subsequent disk management API call is made with either the
|
||
|
|
QYASSDMO or QYASRDMS APIs using the handle returned from this API, a new timing
|
||
|
|
cycle begins. This timeout cycle restarts only after an operation (QYASSDMO)
|
||
|
|
has completed or a status check (QYASRDMS) has been requested using the
|
||
|
|
associated session handle. The timeout cycle is suspended while an action is in
|
||
|
|
progress that was called using the QYASSDMO API.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<p>To use this API, you must have *SERVICE special authority or be authorized
|
||
|
|
to the Service Disk Units function of Operating System/400 through iSeries
|
||
|
|
Navigator's Application Administration support. The Change Function Usage
|
||
|
|
Information (QSYCHFUI) API, with a function ID of QIBM_QYAS_SERVICE_DISKMGMT,
|
||
|
|
also can be used to change the list of users who are allowed to work with disk
|
||
|
|
units.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Session handle</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>An 8-byte field containing a unique ID that will be used in subsequent disk
|
||
|
|
management API calls for the duration of the active session. The session handle
|
||
|
|
contains arbitrary binary data and should not be interpreted as character
|
||
|
|
data.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<table width="100%" cellpadding="5">
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top" width="15%">CPF2277 E</td>
|
||
|
|
<td align="left" valign="top" width="85%">User &1 not allowed to use
|
||
|
|
function &2.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPFBA21 E</td>
|
||
|
|
<td align="left" valign="top">A session is active.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPFBA22 E</td>
|
||
|
|
<td align="left" valign="top">A save storage operation is in progress.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPFBA25 E</td>
|
||
|
|
<td align="left" valign="top">A general DASD management error has
|
||
|
|
occurred.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPFBA48 E</td>
|
||
|
|
<td align="left" valign="top">Operation failed with unrecognized return code,
|
||
|
|
&1.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPFBA53 E</td>
|
||
|
|
<td align="left" valign="top">Unexpected authority validation error has
|
||
|
|
occurred.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3C36 E</td>
|
||
|
|
<td align="left" valign="top">Number of parameters, &1, entered for this
|
||
|
|
API was not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3CF1 E</td>
|
||
|
|
<td align="left" valign="top">Error code parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
API introduced: V4R5
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|