source: branches/samba-3.2.x/docs/htmldocs/manpages/mount.cifs.8.html

Last change on this file was 233, checked in by Herwig Bauernfeind, 16 years ago

Update 3.2 branch to 3.2.9

File size: 24.7 KB
Line 
1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>mount.cifs</title><link rel="stylesheet" href="../samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="mount.cifs.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>mount.cifs &#8212; mount using the Common Internet File System (CIFS)</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">mount.cifs</code> {service} {mount-point} [-o options]</p></div></div><div class="refsect1" lang="en"><a name="id2522954"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a class="citerefentry" href="samba.7.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(7)</span></a> suite.</p><p>mount.cifs mounts a Linux CIFS filesystem. It
2is usually invoked indirectly by
3the <a class="citerefentry" href="mount.8.html"><span class="citerefentry"><span class="refentrytitle">mount</span>(8)</span></a> command when using the
4"-t cifs" option. This command only works in Linux, and the kernel must
5support the cifs filesystem. The CIFS protocol is the successor to the
6SMB protocol and is supported by most Windows servers and many other
7commercial servers and Network Attached Storage appliances as well as
8by the popular Open Source server Samba.
9 </p><p>
10 The mount.cifs utility attaches the UNC name (exported network resource)
11 specified as <span class="emphasis"><em>service</em></span> (using //server/share syntax,
12 where "server" is the server name or IP address and "share" is the name
13 of the share) to the local directory <span class="emphasis"><em>mount-point</em></span>.
14 It is possible to set the mode for mount.cifs to setuid root to allow
15 non-root users to mount shares to directories for which they
16 have write permission.
17 </p><p>
18 Options to <span class="emphasis"><em>mount.cifs</em></span> are specified as a comma-separated
19list of key=value pairs. It is possible to send options other
20than those listed here, assuming that the cifs filesystem kernel module (cifs.ko) supports them.
21Unrecognized cifs mount options passed to the cifs vfs kernel code will be logged to the
22kernel log.
23
24 </p><p><span class="emphasis"><em>mount.cifs</em></span> causes the cifs vfs to launch a thread named cifsd. After mounting it keeps running until
25 the mounted resource is unmounted (usually via the umount utility).
26 </p></div><div class="refsect1" lang="en"><a name="id2483399"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">user=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>specifies the username to connect as. If
27 this is not given, then the environment variable <span class="emphasis"><em>USER</em></span> is used. This option can also take the
28form "user%password" or "workgroup/user" or
29"workgroup/user%password" to allow the password and workgroup
30to be specified as part of the username.
31 </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
32 The cifs vfs accepts the parameter <em class="parameter"><code>user=</code></em>, or for users familiar with smbfs it accepts the longer form of the parameter <em class="parameter"><code>username=</code></em>. Similarly the longer smbfs style parameter names may be accepted as synonyms for the shorter cifs parameters <em class="parameter"><code>pass=</code></em>,<em class="parameter"><code>dom=</code></em> and <em class="parameter"><code>cred=</code></em>.
33 </p></div></dd><dt><span class="term">password=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>specifies the CIFS password. If this
34option is not given then the environment variable
35<span class="emphasis"><em>PASSWD</em></span> is used. If the password is not specified
36directly or indirectly via an argument to mount, <span class="emphasis"><em>mount.cifs</em></span> will prompt
37for a password, unless the guest option is specified.
38</p><p>Note that a password which contains the delimiter
39character (i.e. a comma ',') will fail to be parsed correctly
40on the command line. However, the same password defined
41in the PASSWD environment variable or via a credentials file (see
42below) or entered at the password prompt will be read correctly.
43</p></dd><dt><span class="term">credentials=<em class="replaceable"><code>filename</code></em></span></dt><dd><p>
44 specifies a file that contains a username
45 and/or password and optionally the name of the
46 workgroup. The format of the file is:
47 </p><pre class="programlisting">
48 username=<em class="replaceable"><code>value</code></em>
49 password=<em class="replaceable"><code>value</code></em>
50 workgroup=<em class="replaceable"><code>value</code></em>
51</pre><p>
52This is preferred over having passwords in plaintext in a
53shared file, such as <code class="filename">/etc/fstab</code>. Be sure to protect any
54credentials file properly.
55 </p></dd><dt><span class="term">uid=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>sets the uid that will own all files on
56 the mounted filesystem.
57 It may be specified as either a username or a numeric uid.
58 For mounts to servers which do support the CIFS Unix extensions,
59 such as a properly configured Samba server, the server provides
60 the uid, gid and mode so this parameter should not be
61 specified unless the server and client uid and gid
62 numbering differ. If the server and client are in the
63 same domain (e.g. running winbind or nss_ldap) and
64 the server supports the Unix Extensions then the uid
65 and gid can be retrieved from the server (and uid
66 and gid would not have to be specified on the mount.
67 For servers which do not support the CIFS Unix
68 extensions, the default uid (and gid) returned on lookup
69 of existing files will be the uid (gid) of the person
70 who executed the mount (root, except when mount.cifs
71 is configured setuid for user mounts) unless the "uid="
72 (gid) mount option is specified. For the uid (gid) of newly
73 created files and directories, ie files created since
74 the last mount of the server share, the expected uid
75 (gid) is cached as long as the inode remains in
76 memory on the client. Also note that permission
77 checks (authorization checks) on accesses to a file occur
78 at the server, but there are cases in which an administrator
79 may want to restrict at the client as well. For those
80 servers which do not report a uid/gid owner
81 (such as Windows), permissions can also be checked at the
82 client, and a crude form of client side permission checking
83 can be enabled by specifying file_mode and dir_mode on
84 the client. Note that the mount.cifs helper must be
85 at version 1.10 or higher to support specifying the uid
86 (or gid) in non-numeric form.
87 </p></dd><dt><span class="term">gid=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>sets the gid that will own all files on
88the mounted filesystem. It may be specified as either a groupname or a numeric
89gid. For other considerations see the description of uid above.
90 </p></dd><dt><span class="term">port=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>sets the port number on the server to attempt to contact to negotiate
91CIFS support. If the CIFS server is not listening on this port or
92if it is not specified, the default ports will be tried i.e.
93port 445 is tried and if no response then port 139 is tried.
94 </p></dd><dt><span class="term">servern=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>
95 Specify the server netbios name (RFC1001 name) to use
96 when attempting to setup a session to the server. Although
97 rarely needed for mounting to newer servers, this option
98 is needed for mounting to some older servers (such
99 as OS/2 or Windows 98 and Windows ME) since when connecting
100 over port 139 they, unlike most newer servers, do not
101 support a default server name. A server name can be up
102 to 15 characters long and is usually uppercased.
103 </p></dd><dt><span class="term">netbiosname=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>When mounting to servers via port 139, specifies the RFC1001
104 source name to use to represent the client netbios machine
105 name when doing the RFC1001 netbios session initialize.
106 </p></dd><dt><span class="term">file_mode=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>If the server does not support the CIFS Unix extensions this
107 overrides the default file mode.</p></dd><dt><span class="term">dir_mode=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>If the server does not support the CIFS Unix extensions this
108 overrides the default mode for directories. </p></dd><dt><span class="term">ip=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>sets the destination IP address. This option is set automatically if the server name portion of the requested UNC name can be resolved so rarely needs to be specified by the user.</p></dd><dt><span class="term">domain=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>sets the domain (workgroup) of the user </p></dd><dt><span class="term">guest</span></dt><dd><p>don't prompt for a password </p></dd><dt><span class="term">iocharset</span></dt><dd><p>Charset used to convert local path names to and from
109 Unicode. Unicode is used by default for network path
110 names if the server supports it. If iocharset is
111 not specified then the nls_default specified
112 during the local client kernel build will be used.
113 If server does not support Unicode, this parameter is
114 unused. </p></dd><dt><span class="term">ro</span></dt><dd><p>mount read-only</p></dd><dt><span class="term">rw</span></dt><dd><p>mount read-write</p></dd><dt><span class="term">setuids</span></dt><dd><p>If the CIFS Unix extensions are negotiated with the server
115 the client will attempt to set the effective uid and gid of
116 the local process on newly created files, directories, and
117 devices (create, mkdir, mknod). If the CIFS Unix Extensions
118 are not negotiated, for newly created files and directories
119 instead of using the default uid and gid specified on the
120 the mount, cache the new file's uid and gid locally which means
121 that the uid for the file can change when the inode is
122 reloaded (or the user remounts the share).</p></dd><dt><span class="term">nosetuids</span></dt><dd><p>The client will not attempt to set the uid and gid on
123 on newly created files, directories, and devices (create,
124 mkdir, mknod) which will result in the server setting the
125 uid and gid to the default (usually the server uid of the
126 user who mounted the share). Letting the server (rather than
127 the client) set the uid and gid is the default.If the CIFS
128 Unix Extensions are not negotiated then the uid and gid for
129 new files will appear to be the uid (gid) of the mounter or the
130 uid (gid) parameter specified on the mount.</p></dd><dt><span class="term">perm</span></dt><dd><p>Client does permission checks (vfs_permission check of uid
131 and gid of the file against the mode and desired operation),
132 Note that this is in addition to the normal ACL check on the
133 target machine done by the server software.
134 Client permission checking is enabled by default.</p></dd><dt><span class="term">noperm</span></dt><dd><p>Client does not do permission checks. This can expose
135 files on this mount to access by other users on the local
136 client system. It is typically only needed when the server
137 supports the CIFS Unix Extensions but the UIDs/GIDs on the
138 client and server system do not match closely enough to allow
139 access by the user doing the mount.
140 Note that this does not affect the normal ACL check on the
141 target machine done by the server software (of the server
142 ACL against the user name provided at mount time).</p></dd><dt><span class="term">directio</span></dt><dd><p>Do not do inode data caching on files opened on this mount.
143 This precludes mmaping files on this mount. In some cases
144 with fast networks and little or no caching benefits on the
145 client (e.g. when the application is doing large sequential
146 reads bigger than page size without rereading the same data)
147 this can provide better performance than the default
148 behavior which caches reads (readahead) and writes
149 (writebehind) through the local Linux client pagecache
150 if oplock (caching token) is granted and held. Note that
151 direct allows write operations larger than page size
152 to be sent to the server. On some kernels this requires the cifs.ko module
153 to be built with the CIFS_EXPERIMENTAL configure option.</p></dd><dt><span class="term">mapchars</span></dt><dd><p>Translate six of the seven reserved characters (not backslash, but including the colon, question mark, pipe, asterik, greater than and less than characters)
154 to the remap range (above 0xF000), which also
155 allows the CIFS client to recognize files created with
156 such characters by Windows's POSIX emulation. This can
157 also be useful when mounting to most versions of Samba
158 (which also forbids creating and opening files
159 whose names contain any of these seven characters).
160 This has no effect if the server does not support
161 Unicode on the wire.</p></dd><dt><span class="term">nomapchars</span></dt><dd><p>Do not translate any of these seven characters (default)</p></dd><dt><span class="term">intr</span></dt><dd><p>currently unimplemented</p></dd><dt><span class="term">nointr</span></dt><dd><p>(default) currently unimplemented </p></dd><dt><span class="term">hard</span></dt><dd><p>The program accessing a file on the cifs mounted file system will hang when the
162 server crashes.</p></dd><dt><span class="term">soft</span></dt><dd><p>(default) The program accessing a file on the cifs mounted file system will not hang when the server crashes and will return errors to the user application.</p></dd><dt><span class="term">noacl</span></dt><dd><p>Do not allow POSIX ACL operations even if server would support them.</p><p>
163 The CIFS client can get and set POSIX ACLs (getfacl, setfacl) to Samba servers
164 version 3.0.10 and later. Setting POSIX ACLs requires enabling both XATTR and
165 then POSIX support in the CIFS configuration options when building the cifs
166 module. POSIX ACL support can be disabled on a per mount basis by specifying
167 "noacl" on mount.</p></dd><dt><span class="term">nocase</span></dt><dd><p>Request case insensitive path name matching (case
168 sensitive is the default if the server suports it).
169 </p></dd><dt><span class="term">sec=</span></dt><dd><p>Security mode. Allowed values are:</p><div class="itemizedlist"><ul type="disc"><li><p>none attempt to connection as a null user (no name) </p></li><li><p>krb5 Use Kerberos version 5 authentication</p></li><li><p>krb5i Use Kerberos authentication and packet signing</p></li><li><p>ntlm Use NTLM password hashing (default)</p></li><li><p>ntlmi Use NTLM password hashing with signing (if
170 /proc/fs/cifs/PacketSigningEnabled on or if
171 server requires signing also can be the default)</p></li><li><p>ntlmv2 Use NTLMv2 password hashing</p></li><li><p>ntlmv2i Use NTLMv2 password hashing with packet signing</p></li></ul></div><p>[NB This [sec parameter] is under development and expected to be available in cifs kernel module 1.40 and later]
172 </p></dd><dt><span class="term">nobrl</span></dt><dd><p>Do not send byte range lock requests to the server.
173 This is necessary for certain applications that break
174 with cifs style mandatory byte range locks (and most
175 cifs servers do not yet support requesting advisory
176 byte range locks).
177 </p></dd><dt><span class="term">sfu</span></dt><dd><p>
178 When the CIFS Unix Extensions are not negotiated, attempt to
179 create device files and fifos in a format compatible with
180 Services for Unix (SFU). In addition retrieve bits 10-12
181 of the mode via the SETFILEBITS extended attribute (as
182 SFU does). In the future the bottom 9 bits of the mode
183 mode also will be emulated using queries of the security
184 descriptor (ACL). [NB: requires version 1.39 or later
185 of the CIFS VFS. To recognize symlinks and be able
186 to create symlinks in an SFU interoperable form
187 requires version 1.40 or later of the CIFS VFS kernel module.
188 </p></dd><dt><span class="term">serverino</span></dt><dd><p>Use inode numbers (unique persistent file identifiers)
189 returned by the server instead of automatically generating
190 temporary inode numbers on the client. Although server inode numbers
191 make it easier to spot hardlinked files (as they will have
192 the same inode numbers) and inode numbers may be persistent (which is
193 userful for some sofware),
194 the server does not guarantee that the inode numbers
195 are unique if multiple server side mounts are exported under a
196 single share (since inode numbers on the servers might not
197 be unique if multiple filesystems are mounted under the same
198 shared higher level directory). Note that not all
199 servers support returning server inode numbers, although
200 those that support the CIFS Unix Extensions, and Windows 2000 and
201 later servers typically do support this (although not necessarily
202 on every local server filesystem). Parameter has no effect if
203 the server lacks support for returning inode numbers or equivalent.
204 </p></dd><dt><span class="term">noserverino</span></dt><dd><p>client generates inode numbers (rather than using the actual one
205 from the server) by default.
206 </p></dd><dt><span class="term">nouser_xattr</span></dt><dd><p>(default) Do not allow getfattr/setfattr to get/set xattrs, even if server would support it otherwise. </p></dd><dt><span class="term">rsize=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>default network read size (usually 16K). The client currently
207 can not use rsize larger than CIFSMaxBufSize. CIFSMaxBufSize
208 defaults to 16K and may be changed (from 8K to the maximum
209 kmalloc size allowed by your kernel) at module install time
210 for cifs.ko. Setting CIFSMaxBufSize to a very large value
211 will cause cifs to use more memory and may reduce performance
212 in some cases. To use rsize greater than 127K (the original
213 cifs protocol maximum) also requires that the server support
214 a new Unix Capability flag (for very large read) which some
215 newer servers (e.g. Samba 3.0.26 or later) do. rsize can be
216 set from a minimum of 2048 to a maximum of 130048 (127K or
217 CIFSMaxBufSize, whichever is smaller)
218
219 </p></dd><dt><span class="term">wsize=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>default network write size (default 57344)
220 maximum wsize currently allowed by CIFS is 57344 (fourteen
221 4096 byte pages)</p></dd><dt><span class="term">--verbose</span></dt><dd><p>Print additional debugging information for the mount. Note that this parameter must be specified before the -o. For example:</p><p>mount -t cifs //server/share /mnt --verbose -o user=username</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2481469"></a><h2>SERVICE FORMATTING AND DELIMITERS</h2><p>
222 It's generally preferred to use forward slashes (/) as a delimiter in service names. They are considered to be the "universal delimiter" since they are generally not allowed to be embedded within path components on Windows machines and the client can convert them to blackslashes (\) unconditionally. Conversely, backslash characters are allowed by POSIX to be part of a path component, and can't be automatically converted in the same way.
223 </p><p>
224 mount.cifs will attempt to convert backslashes to forward slashes where it's able to do so, but it cannot do so in any path component following the sharename.
225 </p></div><div class="refsect1" lang="en"><a name="id2481910"></a><h2>ENVIRONMENT VARIABLES</h2><p>
226 The variable <span class="emphasis"><em>USER</em></span> may contain the username of the
227person to be used to authenticate to the server.
228The variable can be used to set both username and
229password by using the format username%password.
230 </p><p>
231 The variable <span class="emphasis"><em>PASSWD</em></span> may contain the password of the
232person using the client.
233 </p><p>
234 The variable <span class="emphasis"><em>PASSWD_FILE</em></span> may contain the pathname
235of a file to read the password from. A single line of input is
236read and used as the password.
237 </p></div><div class="refsect1" lang="en"><a name="id2481944"></a><h2>NOTES</h2><p>This command may be used only by root, unless installed setuid, in which case the noeexec and nosuid mount flags are enabled.</p></div><div class="refsect1" lang="en"><a name="id2481956"></a><h2>CONFIGURATION</h2><p>
238The primary mechanism for making configuration changes and for reading
239debug information for the cifs vfs is via the Linux /proc filesystem.
240In the directory <code class="filename">/proc/fs/cifs</code> are various
241configuration files and pseudo files which can display debug information.
242There are additional startup options such as maximum buffer size and number
243of buffers which only may be set when the kernel cifs vfs (cifs.ko module) is
244loaded. These can be seen by running the modinfo utility against the file
245cifs.ko which will list the options that may be passed to cifs during module
246installation (device driver load).
247For more information see the kernel file <code class="filename">fs/cifs/README</code>.
248</p></div><div class="refsect1" lang="en"><a name="id2481989"></a><h2>BUGS</h2><p>Mounting using the CIFS URL specification is currently not supported.
249 </p><p>The credentials file does not handle usernames or passwords with
250 leading space.</p><p>
251Note that the typical response to a bug report is a suggestion
252to try the latest version first. So please try doing that first,
253and always include which versions you use of relevant software
254when reporting bugs (minimum: mount.cifs (try mount.cifs -V), kernel (see /proc/version) and
255server type you are trying to contact.
256</p></div><div class="refsect1" lang="en"><a name="id2482014"></a><h2>VERSION</h2><p>This man page is correct for version 1.52 of
257 the cifs vfs filesystem (roughly Linux kernel 2.6.24).</p></div><div class="refsect1" lang="en"><a name="id2482026"></a><h2>SEE ALSO</h2><p>
258 Documentation/filesystems/cifs.txt and fs/cifs/README in the linux kernel
259 source tree may contain additional options and information.
260</p><p><a class="citerefentry" href="umount.cifs.8.html"><span class="citerefentry"><span class="refentrytitle">umount.cifs</span>(8)</span></a></p></div><div class="refsect1" lang="en"><a name="id2482047"></a><h2>AUTHOR</h2><p>Steve French</p><p>The syntax and manpage were loosely based on that of smbmount. It
261 was converted to Docbook/XML by Jelmer Vernooij.</p><p>The maintainer of the Linux cifs vfs and the userspace
262 tool <span class="emphasis"><em>mount.cifs</em></span> is <a class="ulink" href="mailto:sfrench@samba.org" target="_top">Steve French</a>.
263 The <a class="ulink" href="mailto:linux-cifs-client@lists.samba.org" target="_top">Linux CIFS Mailing list</a>
264 is the preferred place to ask questions regarding these programs.
265 </p></div></div></body></html>
Note: See TracBrowser for help on using the repository browser.