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

451 lines
22 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>Add Mounted FS (ADDMFS)</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="ADDMFS.Top_Of_Page"></a>
<h2>Add Mounted FS (ADDMFS)</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="#ADDMFS.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ADDMFS.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ADDMFS.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ADDMFS"></a>
<p>The Add Mounted File System (ADDMFS) command makes the objects in a file system accessible to the integrated file system name space. The file system to be made accessible can be either a user-defined file system (*UDFS) on the local system, a remote file system accessed through a local Network File System client (*NFS), or a local or remote NetWare file system (*NETWARE). The directory that is the destination for the mount, the <b>Directory to mount over (MNTOVRDIR)</b> parameter, must exist.
</p>
<p>This command can also be issued using the following alternative command name:
</p>
<ul>
<li>MOUNT
</li>
</ul>
<p>For more information about Network File System commands, see Network File System book, SC41-5714
</p>
<p><b>Restrictions:</b>
</p>
<ol>
<li>The user must have input/output (I/O) system configuration (*IOSYSCFG) special authority to use this command.
</li>
<li>If the user is mounting a NetWare file system, the user must have execute (*EXECUTE) authority to the file system to be mounted.
</li>
<li>The user must have write (*W) authority to the directory to be mounted over.
</li>
<li>The user must have execute (*X) authority to each directory in the path.
</li>
</ol>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDMFS.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDMFS.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="#ADDMFS.TYPE"><b>TYPE</b></a></td>
<td valign="top">Type of file system</td>
<td valign="top">*NFS, *UDFS, *NETWARE</td>
<td valign="top">Required, Key, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#ADDMFS.MFS"><b>MFS</b></a></td>
<td valign="top">File system to mount</td>
<td valign="top"><i>Path name</i></td>
<td valign="top">Required, Key, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#ADDMFS.MNTOVRDIR"><b>MNTOVRDIR</b></a></td>
<td valign="top">Directory to mount over</td>
<td valign="top"><i>Path name</i></td>
<td valign="top">Required, Key, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#ADDMFS.OPTIONS"><b>OPTIONS</b></a></td>
<td valign="top">Mount options</td>
<td valign="top"><i>Character value</i>, <b><u>*DFT</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#ADDMFS.CCSID"><b>CCSID</b></a></td>
<td valign="top">Coded character set ID</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Data file CCSID</td>
<td valign="top">
1-65533, *ASCII, *JOBCCSID, <b><u>*BINARY</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Path name CCSID</td>
<td valign="top">
1-65533, <b><u>*ASCII</u></b>, *JOBCCSID</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#ADDMFS.CODEPAGE"><b>CODEPAGE</b></a></td>
<td valign="top">Code page</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Data file code page</td>
<td valign="top">
1-32767, *ASCII, *JOBCCSID, <b><u>*BINARY</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Path name code page</td>
<td valign="top">
1-32767, <b><u>*ASCII</u></b>, *JOBCCSID</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#ADDMFS.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ADDMFS.TYPE"></a>
<h3>Type of file system (TYPE)</h3>
<p>Specifies the type of file system to be mounted. The type of mount determines the correct form for the <b>File system to mount (MFS)</b> parameter.
</p>
<dl>
<dt><b>*NFS</b></dt>
<dd>The file system specified for the MFS parameter is a Network File System. The MFS parameter must be of the form <i>hostname:pathname</i> where <i>hostname</i> can either be the name of a system or an IP address, and pathname must be an absolute path name.
</dd>
<dt><b>*UDFS</b></dt>
<dd>The file system specified for the MFS parameter is a user-defined file system. The MFS parameter must be in one of the two following forms:
<ul>
<li><i>/dev/qaspXX/udfsname.udfs</i> where <i>XX</i> is one of the valid system or basic user auxiliary storage pool (ASP) numbers on the system, and <i>udfsname</i> is the name of the user-defined file system. All other parts of the name must appear as in the example above.
</li>
<li><i>/dev/aspname/udfsname.udfs</i>, where <i>aspname</i> is one of the valid independent ASP names on the system, and <i>udfsname</i> is the name of the user-defined file system. All other parts of the name must appear as in the example above.
</li>
</ul>
<p>The name part of the path must be unique within the specified <i>qaspXX</i> or <i>aspname</i> directory.
</p>
</dd>
<dt><b>*NETWARE</b></dt>
<dd>The file system specified for the MFS parameter is a NetWare file system. The MFS parameter must be one of the following forms:
<ul>
<li><i>server/volume:pathname</i>, where <i>pathname</i> is optional.
</li>
<li>NetWare Directory Services (NDS) context to a volume, a directory map object to mount, or an alias to a volume or directory map object. The NDS context can be a distinguished or relative context. If a relative context is specified the current context for the job is searched, and if it is not found the default system context is searched. If a context to a volume or an alias to a volume is specified an optional directory path may also be specified.
<p>
<b>Note: </b>On the MFS parameter, if a relative context is specified that contains no dots and no path name after the colon, the user must be sure to quote the parameter value when prompting on the command. The command analyzer may interpret the MFS value as a label and remove the trailing colon.
</p>
</li>
</ul>
</dd>
</dl>
<p>This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDMFS.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDMFS.MFS"></a>
<h3>File system to mount (MFS)</h3>
<p>Specifies the path name of the file system to be mounted. It can be the path to a local Block Special File (*BLKSF), a remote NFS path name, or the path of a NetWare file system. See the <b>Type of file system (TYPE)</b> parameter to determine the correct format for the MFS parameter.
</p>
<p>This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDMFS.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDMFS.MNTOVRDIR"></a>
<h3>Directory to mount over (MNTOVRDIR)</h3>
<p>Specifies the path name of the existing directory that the file system will be mounted over. This directory gets 'covered' by the mounted file system. This directory must exist.
</p>
<p>Multiple file systems can be mounted over the same directory, one on top of the other. However, only the topmost mounted file system is accessible, and the file systems must later be unmounted in the opposite order from which they were mounted (last-in first-out order).
</p>
<p>This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDMFS.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDMFS.OPTIONS"></a>
<h3>Mount options (OPTIONS)</h3>
<p>The options list contains a character string of mount options. The options are separated by commas. For some options, an equal '=' and a value follow the option. If an option is not specified, the default value for that option will be used. The options list may contain spaces.
</p>
<dl>
<dt><b><u>*DFT</u></b></dt>
<dd>The default value for the options string for the mount of a Network File System (*NFS) is:
<p>
<pre>
'rw,suid,rsize=8096,wsize=8096,timeo=20,retrans=5,
acregmin=30,acregmax=60,acdirmin=30,acdirmax=60,hard'
</pre>
</p>
<p>The default value for the options string for the mount of a user-defined file system (*UDFS) is:
</p>
<p>
<pre>
'rw,suid'
</pre>
</p>
<p>The default value for the options string for the mount of a NetWare file system (*NETWARE) is:
</p>
<p>
<pre>
'rw,acregmax=60,acdirmax=60'
</pre>
</p>
<p>For the mount of a Network File System, all of the following options are valid. For the mount of a user-defined file system, only the <i>ro</i>, <i>rw</i>, <i>suid</i> and <i>nosuid</i> options are valid. For the mount of a NetWare file system, only the <i>ro</i>, <i>rw</i>, <i>acregmax</i>, <i>acdirmax</i>, <i>noac</i>, and <i>nocto</i> options are valid. If options are specified that are not valid for the file system type to be mounted, they are ignored.
</p>
</dd>
<dt><b><i>options-list</i></b></dt>
<dd>The following are the available options and their descriptions:
<dl>
<dt><b>rw|ro</b></dt>
<dd>This option specifies the protection for the mounted file system. Either <i>ro</i> (read-only) or <i>rw</i> (read-write) may be specified. If neither is specified, <i>rw</i> is assumed.
</dd>
<dt><b>suid|nosuid</b></dt>
<dd>For the mount of a user-defined file system or a Network File System, if <i>suid</i> is specified, setuid execution is allowed. This means that bits other than the permission bits may be set. If <i>nosuid</i> is specified, setuid execution is not allowed.
</dd>
<dt><b>hard|soft</b></dt>
<dd>For the mount of a Network File System, specifies whether NFS file systems are hard or soft mounted. Hard mounted means that operations on them are retried until they are acknowledged by the server. Soft mounted means that a timeout error is returned if a remote operation fails the number of times specified on the <i>retrans</i> option. If neither is specified, <i>hard</i> is assumed.
</dd>
<dt><b>rsize=n</b></dt>
<dd>For the mount of a Network File System, specifies the size of the read buffer in bytes. The read buffer is used for data transfer between the NFS client and the remote NFS server on an NFS read request. The allowed range is 512 to 8096. If <i>rsize</i> is not specified, the default value of 8096 is assumed. For better performance, the read buffer should be a multiple of the the application buffer size.
</dd>
<dt><b>wsize=n</b></dt>
<dd>For the mount of a Network File System, specifies the size of the write buffer in bytes. The write buffer is used for data transfer between the NFS client and the remote NFS server on an NFS write request. The allowed range is 512 to 8096. If <i>wsize</i> is not specified, the default value of 8096 is assumed. For better performance, the write buffer should be a multiple of the application buffer size.
</dd>
<dt><b>timeo=n</b></dt>
<dd>For the mount of a Network File System, specifies the amount of time, in tenths of seconds, to wait for the client to respond on each try. The allowed range is 0 to 10000. If <i>timeo</i> is not specified, the default value of 20 tenths of a second (2 seconds) is assumed.
</dd>
<dt><b>retry=n</b></dt>
<dd>For the mount of a Network File System, specifies the number of times to retry the mount operation. The allowed range is 0 to 10000. If <i>retry</i> is not specified, the default value of 5 retransmission attempts is assumed.
</dd>
<dt><b>retrans=n</b></dt>
<dd>For the mount of a Network File System, specifies the number of times to retry the transmission to the server. The allowed range is 0 to 10. If <i>retrans</i> is not specified, the default value of 5 retransmission attempts is assumed.
</dd>
<dt><b>acregmin=n</b></dt>
<dd>For the mount of a Network File System, specifies the minimum number of seconds to hold locally stored file attributes after file updates. The allowed range is 1 to 3600. If <i>acregmin</i> is not specified, the default value of 30 seconds is assumed.
</dd>
<dt><b>acregmax=n</b></dt>
<dd>For the mount of a Network File System or a NetWare file system, specifies the maximum number of seconds to hold locally stored file attributes after file updates. The allowed range is 1 to 2,000,000,000. If <i>acregmax</i> is not specified, the default value of 60 seconds is assumed.
</dd>
<dt><b>acdirmin=n</b></dt>
<dd>For the mount of a Network File System, specifies the minimum number of seconds to hold locally stored directory attributes after a directory update. The allowed range is 1 to 3600. If <i>acdirmin</i> is not specified, the default value of 30 seconds is assumed.
</dd>
<dt><b>acdirmax=n</b></dt>
<dd>For the mount of a Network File System or a NetWare file system, specifies the maximum number of seconds to hold locally stored directory attributes after a directory update. The allowed range is 1 to 2,000,000,000. If <i>acdirmax</i> is not specified the default value of 60 seconds is assumed.
</dd>
<dt><b>nocto</b></dt>
<dd>For the mount of a Network File System or a NetWare file system, specifies whether to force the refresh of remote attributes when opening a file. If this option is present, attributes are not refreshed from the server when opening a file, and changes are not sent to the server on the last close. If <i>nocto</i> is not present, the default value of no suppression is assumed.
</dd>
<dt><b>noac</b></dt>
<dd>For the mount of a Network File System or a NetWare file system, specifies whether to suppress local storage of attributes and names. If this option is present, local storage of attributes and names is suppressed. If <i>noac</i> is not present, the default value of no suppression is assumed. If <i>noac</i> is specified, values specified for <i>agregmin</i>, <i>agregmax</i>, <i>agdirmin</i>, and <i>agdirmax</i> may be specified but are not used.
</dd>
</dl>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDMFS.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDMFS.CCSID"></a>
<h3>Coded character set ID (CCSID)</h3>
<p>Specifies, for Network File Systems, a pair of coded character set identifiers (CCSIDs) to identify a specific character representation to be used. The first CCSID specifies what encoding scheme should be assumed for data files on the remote system. The second CCSID specifies what encoding scheme should be assumed for path names on the remote system.
</p>
<p>This parameter is only valid if mounting a Network File System.
</p>
<p><b>Element 1: Data file CCSID</b>
</p>
<dl>
<dt><b><u>*BINARY</u></b></dt>
<dd>No conversion is used.
</dd>
<dt><b>*ASCII</b></dt>
<dd>The ASCII equivalent of the default job CCSID associated with the current job is used.
</dd>
<dt><b>*JOBCCSID</b></dt>
<dd>The CCSID from the default job CCSID is used.
</dd>
<dt><b><i>1-65533</i></b></dt>
<dd>Specify a CCSID to be assumed for data files on the remote system.
</dd>
</dl>
<p><b>Element 2: Path name CCSID</b>
</p>
<dl>
<dt><b><u>*ASCII</u></b></dt>
<dd>The ASCII equivalent of the default job CCSID associated with the current job is used.
</dd>
<dt><b>*JOBCCSID</b></dt>
<dd>The CCSID from the default job CCSID is used.
</dd>
<dt><b><i>1-65533</i></b></dt>
<dd>Specify a CCSID to be assumed for path names on the remote system. Only CCSIDs that can be converted into UCS-2 level 1 (1200) are supported. See Globalization information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter for a list of supported conversions.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDMFS.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDMFS.CODEPAGE"></a>
<h3>Code page (CODEPAGE)</h3>
<p>Specifies, for Network File Systems, a pair of code pages. The first code page specifies what code page should be assumed for data files on the remote system. The second code page specifies what code page should be assumed for path names on the remote system.
</p>
<p>This parameter is only valid if mounting a Network File System.
</p>
<p>
<b>Note: </b>This parameter is replaced by <b>Coded character set ID (CCSID)</b> but the CODEPAGE parameter can still be used. However, because this parameter may be removed in a later release, whenever possible use the CCSID parameter.
</p>
<p><b>Element 1: Data file code page</b>
</p>
<p>
<b>Note: </b>A code page that has the same number of bytes per character as the original data should be specified.
</p>
<dl>
<dt><b><u>*BINARY</u></b></dt>
<dd>No conversion is used.
</dd>
<dt><b>*ASCII</b></dt>
<dd>The ASCII equivalent of the default job coded character set identifier (CCSID) associated with the current job is used.
</dd>
<dt><b>*JOBCCSID</b></dt>
<dd>The default job coded character set identifier (CCSID) associated with the current job is used.
</dd>
<dt><b><i>1-32767</i></b></dt>
<dd>Specify a code page to be assumed for data files on the remote system. Only code pages that correspond to single-byte or double-byte encoding schemes are supported. Code pages that correspond to mixed-byte encoding schemes are not supported.
</dd>
</dl>
<p><b>Element 2: Path name code page</b>
</p>
<dl>
<dt><b><u>*ASCII</u></b></dt>
<dd>The ASCII equivalent of the default job coded character set identifier (CCSID) associated with the current job is used.
</dd>
<dt><b>*JOBCCSID</b></dt>
<dd>The default job coded character set identifier (CCSID) associated with the current job is used.
</dd>
<dt><b><i>1-32767</i></b></dt>
<dd>Specify a code page to be assumed for path names on the remote system. Only code pages whose CCSIDs can be converted into UCS-2 level 1 (1200) are supported. See Globalization information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter for a list of supported conversions.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDMFS.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDMFS.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Mounting a User-Defined File System</b>
</p>
<p>
<pre>
ADDMFS TYPE(*UDFS) MFS('/DEV/QASP03/PROD1') MNTOVRDIR('DIRB')
</pre>
</p>
<p>This command mounts a user-defined file system PROD1 over the directory, DIRB. It uses the defaults for the other parameters.
</p>
<p><b>Example 2: Mounting a Network File System</b>
</p>
<p>
<pre>
ADDMFS TYPE(*NFS) MFS('RAINFALL:/QSYS.LIB/RAY.LIB')
MNTOVRDIR('/mystuff')
</pre>
</p>
<p>This command mounts the <i>/qsys.lib/ray.lib</i> file system from the remote system RAINFALL into the directory <i>/mystuff</i>.
</p>
<p><b>Example 3: Mounting a Network File System with OPTIONS</b>
</p>
<p>
<pre>
ADDMFS TYPE(*NFS) MFS('RAINFALL:/QSYS.LIB/RAY.LIB')
MNTOVRDIR('/mystuff')
OPTIONS('ro,nosuid,rsize=256, retrans=10')
CODEPAGE(*ASCII *JOBCCSID) CCSID(*ASCII *JOBCCSID)
</pre>
</p>
<p>This command mounts the <i>/qsys.lib/ray.lib</i> file system from the remote system RAINFALL into the directory <i>/mystuff</i>. In addition it specifies to mount as read-only, not allow setuid execution, set the read buffer to 256 bytes, and the retransmission attempts to 10. The job CCSID is used to determine the coded character set identifier to use for remote path names.
</p>
<p><b>Example 4: Mounting a NetWare File System with OPTIONS</b>
</p>
<p>
<pre>
ADDMFS TYPE(*NETWARE) MFS('RCHNWSVR1/LOTUS:LOTSUITE/SMARTCTR')
MNTOVRDIR('/temp1') OPTIONS('ro,agregmax=120')
</pre>
</p>
<p>This command mounts the NetWare directory <i>LOTSUITE/SMARTCTR</i> contained in the volume <i>LOTUS</i> that resides on server <i>RCHNWSVR1</i> over the directory <i>/temp1</i>. In addition it specifies to mount as read-only, sets the maximum time to store file attributes locally to 120 seconds.
</p>
<p><b>Example 5: Mounting using a NetWare Directory Services Context</b>
</p>
<p>Following are several examples of mounting a NetWare file system using NetWare Directory Services (NDS) contexts.
</p>
<p>
<pre>
ADDMFS TYPE(*NETWARE) MFS('.LOTUS_VOL.ROCHESTER.IBM')
MNTOVRDIR('/temp1')
</pre>
</p>
<p>This command mounts NDS volume <i>LOTUS_VOL</i> using a distinguished context, over the directory <i>/temp1</i>.
</p>
<p>
<pre>
ADDMFS TYPE(*NETWARE)
MFS('CN=LOTUS_VOL.OU=ROCHESTER:LOTSUITE/SMARTCTR')
MNTOVRDIR('/temp1')
</pre>
</p>
<p>This command mounts path <i>LOTSUITE/SMARTCTR</i> on NDS volume <i>LOTUS</i> using a relative path and fully qualified names, over the directory <i>/temp1</i>.
</p>
<p>
<pre>
ADDMFS TYPE(*NETWARE) MFS('.CN=LOTUSMAP.OU=ROCHESTER.O=IBM')
MNTOVRDIR('/temp1')
</pre>
</p>
<p>This command mounts a directory map object using a distinguished context and fully qualified names, over the directory <i>/temp1</i>.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDMFS.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDMFS.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPFA09C</b></dt>
<dd>Not authorized to object. Object is &amp;1.
</dd>
<dt><b>CPFA0A2</b></dt>
<dd>Information passed to this operation was not valid.
</dd>
<dt><b>CPFA0A9</b></dt>
<dd>Object not found. Object is &amp;1.
</dd>
<dt><b>CPFA1B8</b></dt>
<dd>*IOSYSCFG authority required to use &amp;1.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDMFS.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>