435 lines
13 KiB
HTML
435 lines
13 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>Perform Miscellaneous File System Functions (qp0fptos) 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. -->
|
|
<!-- file cleaned -->
|
|
<!-- qp0fptos.htm created by Yvonne Griffin on Wed Mar 21 2001 -->
|
|
<!--***********************************************************-->
|
|
<!--************** WARNING **********************************-->
|
|
<!-- This is the external version of this API documentation. -->
|
|
<!-- Depending on what your change is, you may need to also -->
|
|
<!-- update the file in the service API documentation family. -->
|
|
<!-- Look for the file named: (all on one line) -->
|
|
<!-- Z:\lande\shadow\dev2000\ -->
|
|
<!-- osxpft\v5r2m0t.xpf\cur\cmvc\base.pgm\p0f.xpf\qp0fptos_service.htm -->
|
|
<!--************** WARNING ***********************************-->
|
|
<!--***********************************************************-->
|
|
<!-- Change History: -->
|
|
<!-- 010321 YGRIFFIN:Creation -->
|
|
<!-- 010507 JTROUS : Add WARNING and v5r2 change flags -->
|
|
<!-- 010508 JTROUS : Updated *REBUILDDEVNULL to inc dev/zero-->
|
|
<!-- 011022 JTROUS Changes from API Review 1, V5R2 -->
|
|
<!-- 0206?? JET This file has undergone html cleanup -->
|
|
<!-- 030430 JTROUS : add to reference on QSYCHFUI, V5R3 -->
|
|
<!-- 040721 JTROUS : Fix i5/OS reference, no chg flag -->
|
|
<!-- 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 language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
|
</script>
|
|
|
|
<h2>Perform Miscellaneous File System Functions (QP0FPTOS) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<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%">Function type</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">Function extension 1</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Function extension 2</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
|
|
<p>The Perform Miscellaneous File System Function (QP0FPTOS) API is used to
|
|
perform a variety of file system functions. The first parameter defines the
|
|
type of function that is requested. Other parameters are optional, depending on
|
|
the selected function. The output from this API varies, based on the selected
|
|
function. See the function descriptions for more details.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<p>To call this program you must have *SERVICE special authority, or be
|
|
authorized to the Service Dump function of i5/OS through iSeries
|
|
Navigator's Application Administration support. The
|
|
Change Function Usage (CHGFCNUSG) command or
|
|
<a href="qsychfui.htm">
|
|
Change Function Usage Information (QSYCHFUI) API</a>, with a function ID of
|
|
QIBM_SERVICE_DUMP, also can be used to change the list of users allowed to
|
|
perform dump operations.</p>
|
|
|
|
<p><strong>Note:</strong> Adopted authority is not used.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<p>Required parameters vary according to the selected function. The selected
|
|
function is identified by the first parameter on the call to the API.</p>
|
|
|
|
<dl>
|
|
<dt><strong>Function Type</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The desired file system function to perform. Valid values follow:</p>
|
|
|
|
<dl>
|
|
<dt><em>(1) *DUMP</em></dt>
|
|
|
|
<dd>Creates a general file system dump in a spooled file with file name
|
|
"QSYSPRT" and with "QP0FDUMP" in the User Data field. No other parameters are
|
|
required or supported when *DUMP is specified.<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>(2) *DUMPALL</em></dt>
|
|
|
|
<dd>Creates a variety of file system dumps in a single spooled file with file
|
|
name "QSYSPRT" and with "QP0FDUMP" in the User Data field. The following table
|
|
describes the optional parameter when *DUMPALL is specified.<br>
|
|
<br>
|
|
|
|
|
|
<table border width="100%">
|
|
<tr>
|
|
<th align="left" valign="bottom" width="12%">Function</th>
|
|
<th align="left" valign="bottom" width="15%">Function extension 1</th>
|
|
<th align="left" valign="bottom" width="15%">Function extension 2</th>
|
|
<th align="left" valign="bottom" width="58%">Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">*DUMPALL</td>
|
|
<td align="left" valign="top">Job number (CHAR 6)</td>
|
|
<td align="left" valign="top">(Not supported)</td>
|
|
<td align="left" valign="top">Specifies the job that is dumped. If a job is not
|
|
specified, the data is dumped for all jobs. If there are multiple jobs with the
|
|
same number, the first one encountered will be dumped.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>(3) *DUMPLFS</em></dt>
|
|
|
|
<dd>Creates a dump of logical file system data in a spooled file with file name
|
|
"QSYSPRT" and with "QP0FDUMP" in the User Data field. The following table
|
|
describes the optional parameter when *DUMPLFS is specified.<br>
|
|
<br>
|
|
|
|
|
|
<table border width="100%">
|
|
<tr>
|
|
<th align="left" valign="bottom" width="12%">Function</th>
|
|
<th align="left" valign="bottom" width="15%">Function extension 1</th>
|
|
<th align="left" valign="bottom" width="15%">Function extension 2</th>
|
|
<th align="left" valign="bottom" width="58%">Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">*DUMPLFS</td>
|
|
<td align="left" valign="top">Job number (CHAR 6)</td>
|
|
<td align="left" valign="top">(Not supported)</td>
|
|
<td align="left" valign="top">Specifies the job that is dumped. If a job is not
|
|
specified, the data is dumped for all jobs. If there are multiple jobs with the
|
|
same number, the first one encountered will be dumped.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>(4) *NFSFORCE</em></dt>
|
|
|
|
<dd>Sets various values and modes for the network file system. The following
|
|
table describes the required parameters when *NFSFORCE is specified.<br>
|
|
<br>
|
|
|
|
|
|
<table border width="100%">
|
|
<tr>
|
|
<th align="left" valign="bottom" width="12%">Function</th>
|
|
<th align="left" valign="bottom" width="15%">Function extension 1</th>
|
|
<th align="left" valign="bottom" width="15%">Function extension 2</th>
|
|
<th align="left" valign="bottom" width="58%">Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">*NFSFORCE</td>
|
|
<td align="left" valign="top">V2</td>
|
|
<td align="left" valign="top">ON or OFF</td>
|
|
<td align="left" valign="top">If ON, indicates version 2 mounts only by the
|
|
client. If QNFSMNTD is started afterwards, then server will permit version 2
|
|
mounts only.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>(5) *REBUILDDEVNULL</em></dt>
|
|
|
|
<dd>Attempts to create the /dev/null and dev/zero character special files. If
|
|
an existing dev/null or dev/zero object exists that is not a character special
|
|
file, then the object is renamed to /dev/null.prv or dev/zero.prv. If
|
|
/dev/null.prv or /dev/zero.prv exists, then it it renamed to /dev/null.prv.001
|
|
or /dev/zero.prv.001, /dev/null.prv.002 or /dev/zero.prv.002, and so on, until
|
|
a name is found for the object. If 999 is exceeded and the rename cannot be
|
|
done, the object is not renamed and an informational message is issued and the
|
|
QP0FPTOS program completes successfully. No other parameters are required or
|
|
supported when *REBUILDDEVNULL is specified.<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>(6) *TRACE6ON or *TRACE6OFF</em></dt>
|
|
|
|
<dd>*TRACE6ON starts the logging of trace messages in the user job log for some
|
|
network file system functions. *TRACE6OFF stops the logging of these
|
|
messages.<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>(7) *TRACE8ON or *TRACE8OFF</em></dt>
|
|
|
|
<dd>*TRACE8ON starts the logging of trace messages to the QSYSOPR message queue
|
|
for some network file system functions. *TRACE8OFF stops the logging of these
|
|
messages.<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>(8) *TRACE9ON or *TRACE9OFF</em></dt>
|
|
|
|
<dd>*TRACE9ON starts the collection of some network file system statistics and
|
|
resets the statistics. *TRACE9OFF stops the collection of these statistics.<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><em>(9) *DUMPNFSSTATS</em></dt>
|
|
|
|
<dd>Creates a file system dump of network file system (NFS) statistics (both
|
|
client and server) in a spooled file with file name "QSYSPRT" and with
|
|
"QP0FDUMP" in the User Data field. The information dumped comes from a window
|
|
of time specified with the *TRACE9ON/OFF function. No other parameters are
|
|
required or supported when *DUMPNFSSTATS is specified.<br>
|
|
<br>
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
|
|
<dt><strong>Function extension 1</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>Function extension 1 is optional or required, based on the first parameter.
|
|
Whenever it is valid, function extension 1 is described above along with a
|
|
first parameter description. Function extension 1 is valid when the first
|
|
parameter is listed below:</p>
|
|
|
|
<dl>
|
|
<dt><em>(1) *DUMPALL</em></dt>
|
|
|
|
<dt><em>(2) *DUMPLFS</em></dt>
|
|
|
|
<dt><em>(3) *NFSFORCE</em></dt>
|
|
</dl>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Function extension 2</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>Function extension 2 is optional or required, based on the first parameter.
|
|
Whenever it is valid, function extension 2 is described above along with a
|
|
first parameter description. Function extension 2 is valid when the first
|
|
parameter is listed below:</p>
|
|
|
|
<dl>
|
|
<dt><em>(1) *NFSFORCE</em></dt>
|
|
</dl>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="USAGE_NOTES">Usage Notes</a></h3>
|
|
|
|
<p>If this API is called without the first parameter that is required, then
|
|
message CPFBC53 is issued to the caller. This message specifies a parameter
|
|
that is not valid. To recover, the caller is pointed to the API
|
|
documentation.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top" nowrap>Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPE3418 E</td>
|
|
<td align="left" valign="top">Possible APAR condition or hardware failure.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9872 E</td>
|
|
<td align="left" valign="top">Program or service program &1 in library
|
|
&2 ended. Reason code &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA0A0 E</td>
|
|
<td align="left" valign="top">Object name already exists.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFA0D4 E</td>
|
|
<td align="left" valign="top">File system error occurred. Error number
|
|
&1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPDA0FF E</td>
|
|
<td align="left" valign="top">Program not called. You need *SERVICE authority
|
|
to call this program.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFBC53 E</td>
|
|
<td align="left" valign="top">Invalid parameter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFBC54 E</td>
|
|
<td align="left" valign="top">Not authorized to call program.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3>Examples</h3>
|
|
|
|
<p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a>
|
|
for information pertaining to code examples.</p>
|
|
|
|
<table cellpadding="5" width="60%">
|
|
<tr>
|
|
<td align="left" valign="top">CALL QP0FPTOS *DUMP</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CALL QP0FPTOS (*DUMPALL '055229')</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CALL QP0FPTOS (*DUMPLFS '055229')</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CALL QP0FPTOS (*NFSFORCE V2 ON)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CALL QP0FPTOS *REBUILDDEVNULL</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CALL QP0FPTOS *TRACE6ON</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CALL QP0FPTOS *TRACE6OFF</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CALL QP0FPTOS *TRACE8ON</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CALL QP0FPTOS *TRACE8OFF</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CALL QP0FPTOS *TRACE9ON</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CALL QP0FPTOS *TRACE9OFF</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CALL QP0FPTOS *DUMPNFSSTATS</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<hr>
|
|
API introduced: V5R2
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"unix.htm">UNIX-Type APIs</a> | <a href="aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|