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 — 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="id2522940"></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
2
is usually invoked indirectly by
3
the <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
5
support the cifs filesystem. The CIFS protocol is the successor to the
6
SMB protocol and is supported by most Windows servers and many other
7
commercial servers and Network Attached Storage appliances as well as
8
by the popular Open Source server Samba.
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.
18
Options to <span class="emphasis"><em>mount.cifs</em></span> are specified as a comma-separated
19
list of key=value pairs. It is possible to send options other
20
than those listed here, assuming that the cifs filesystem kernel module (cifs.ko) supports them.
21
Unrecognized cifs mount options passed to the cifs vfs kernel code will be logged to the
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).
27
<span class="emphasis"><em>mount.cifs -V</em></span> command displays the version of cifs mount helper.
30
<span class="emphasis"><em>modinfo cifs</em></span> command displays the version of cifs module.
31
</p></div><div class="refsect1" lang="en"><a name="id2483524"></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
32
this is not given, then the environment variable <span class="emphasis"><em>USER</em></span> is used. This option can also take the
33
form "user%password" or "workgroup/user" or
34
"workgroup/user%password" to allow the password and workgroup
35
to be specified as part of the username.
36
</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
37
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>.
38
</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
39
option is not given then the environment variable
40
<span class="emphasis"><em>PASSWD</em></span> is used. If the password is not specified
41
directly or indirectly via an argument to mount, <span class="emphasis"><em>mount.cifs</em></span> will prompt
42
for a password, unless the guest option is specified.
43
</p><p>Note that a password which contains the delimiter
44
character (i.e. a comma ',') will fail to be parsed correctly
45
on the command line. However, the same password defined
46
in the PASSWD environment variable or via a credentials file (see
47
below) or entered at the password prompt will be read correctly.
48
</p></dd><dt><span class="term">credentials=<em class="replaceable"><code>filename</code></em></span></dt><dd><p>
49
specifies a file that contains a username
50
and/or password and optionally the name of the
51
workgroup. The format of the file is:
52
</p><pre class="programlisting">
53
username=<em class="replaceable"><code>value</code></em>
54
password=<em class="replaceable"><code>value</code></em>
55
domain=<em class="replaceable"><code>value</code></em>
57
This is preferred over having passwords in plaintext in a
58
shared file, such as <code class="filename">/etc/fstab</code>. Be sure to protect any
59
credentials file properly.
60
</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
61
the mounted filesystem.
62
It may be specified as either a username or a numeric uid.
63
For mounts to servers which do support the CIFS Unix extensions,
64
such as a properly configured Samba server, the server provides
65
the uid, gid and mode so this parameter should not be
66
specified unless the server and client uid and gid
67
numbering differ. If the server and client are in the
68
same domain (e.g. running winbind or nss_ldap) and
69
the server supports the Unix Extensions then the uid
70
and gid can be retrieved from the server (and uid
71
and gid would not have to be specified on the mount.
72
For servers which do not support the CIFS Unix
73
extensions, the default uid (and gid) returned on lookup
74
of existing files will be the uid (gid) of the person
75
who executed the mount (root, except when mount.cifs
76
is configured setuid for user mounts) unless the "uid="
77
(gid) mount option is specified. For the uid (gid) of newly
78
created files and directories, ie files created since
79
the last mount of the server share, the expected uid
80
(gid) is cached as long as the inode remains in
81
memory on the client. Also note that permission
82
checks (authorization checks) on accesses to a file occur
83
at the server, but there are cases in which an administrator
84
may want to restrict at the client as well. For those
85
servers which do not report a uid/gid owner
86
(such as Windows), permissions can also be checked at the
87
client, and a crude form of client side permission checking
88
can be enabled by specifying file_mode and dir_mode on
89
the client. Note that the mount.cifs helper must be
90
at version 1.10 or higher to support specifying the uid
91
(or gid) in non-numeric form.
92
</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
93
the mounted filesystem. It may be specified as either a groupname or a numeric
94
gid. For other considerations see the description of uid above.
95
</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
96
CIFS support. If the CIFS server is not listening on this port or
97
if it is not specified, the default ports will be tried i.e.
98
port 445 is tried and if no response then port 139 is tried.
99
</p></dd><dt><span class="term">servern=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>
100
Specify the server netbios name (RFC1001 name) to use
101
when attempting to setup a session to the server. Although
102
rarely needed for mounting to newer servers, this option
103
is needed for mounting to some older servers (such
104
as OS/2 or Windows 98 and Windows ME) since when connecting
105
over port 139 they, unlike most newer servers, do not
106
support a default server name. A server name can be up
107
to 15 characters long and is usually uppercased.
108
</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
109
source name to use to represent the client netbios machine
110
name when doing the RFC1001 netbios session initialize.
111
</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
112
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
113
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
114
Unicode. Unicode is used by default for network path
115
names if the server supports it. If iocharset is
116
not specified then the nls_default specified
117
during the local client kernel build will be used.
118
If server does not support Unicode, this parameter is
119
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
120
the client will attempt to set the effective uid and gid of
121
the local process on newly created files, directories, and
122
devices (create, mkdir, mknod). If the CIFS Unix Extensions
123
are not negotiated, for newly created files and directories
124
instead of using the default uid and gid specified on the
125
the mount, cache the new file's uid and gid locally which means
126
that the uid for the file can change when the inode is
127
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
128
on newly created files, directories, and devices (create,
129
mkdir, mknod) which will result in the server setting the
130
uid and gid to the default (usually the server uid of the
131
user who mounted the share). Letting the server (rather than
132
the client) set the uid and gid is the default.If the CIFS
133
Unix Extensions are not negotiated then the uid and gid for
134
new files will appear to be the uid (gid) of the mounter or the
135
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
136
and gid of the file against the mode and desired operation),
137
Note that this is in addition to the normal ACL check on the
138
target machine done by the server software.
139
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
140
files on this mount to access by other users on the local
141
client system. It is typically only needed when the server
142
supports the CIFS Unix Extensions but the UIDs/GIDs on the
143
client and server system do not match closely enough to allow
144
access by the user doing the mount.
145
Note that this does not affect the normal ACL check on the
146
target machine done by the server software (of the server
147
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.
148
This precludes mmaping files on this mount. In some cases
149
with fast networks and little or no caching benefits on the
150
client (e.g. when the application is doing large sequential
151
reads bigger than page size without rereading the same data)
152
this can provide better performance than the default
153
behavior which caches reads (readahead) and writes
154
(writebehind) through the local Linux client pagecache
155
if oplock (caching token) is granted and held. Note that
156
direct allows write operations larger than page size
157
to be sent to the server. On some kernels this requires the cifs.ko module
158
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)
159
to the remap range (above 0xF000), which also
160
allows the CIFS client to recognize files created with
161
such characters by Windows's POSIX emulation. This can
162
also be useful when mounting to most versions of Samba
163
(which also forbids creating and opening files
164
whose names contain any of these seven characters).
165
This has no effect if the server does not support
166
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
167
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>
168
The CIFS client can get and set POSIX ACLs (getfacl, setfacl) to Samba servers
169
version 3.0.10 and later. Setting POSIX ACLs requires enabling both XATTR and
170
then POSIX support in the CIFS configuration options when building the cifs
171
module. POSIX ACL support can be disabled on a per mount basis by specifying
172
"noacl" on mount.</p></dd><dt><span class="term">nocase</span></dt><dd><p>Request case insensitive path name matching (case
173
sensitive is the default if the server suports it).
174
</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
175
/proc/fs/cifs/PacketSigningEnabled on or if
176
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]
177
</p></dd><dt><span class="term">nobrl</span></dt><dd><p>Do not send byte range lock requests to the server.
178
This is necessary for certain applications that break
179
with cifs style mandatory byte range locks (and most
180
cifs servers do not yet support requesting advisory
182
</p></dd><dt><span class="term">sfu</span></dt><dd><p>
183
When the CIFS Unix Extensions are not negotiated, attempt to
184
create device files and fifos in a format compatible with
185
Services for Unix (SFU). In addition retrieve bits 10-12
186
of the mode via the SETFILEBITS extended attribute (as
187
SFU does). In the future the bottom 9 bits of the mode
188
mode also will be emulated using queries of the security
189
descriptor (ACL). [NB: requires version 1.39 or later
190
of the CIFS VFS. To recognize symlinks and be able
191
to create symlinks in an SFU interoperable form
192
requires version 1.40 or later of the CIFS VFS kernel module.
193
</p></dd><dt><span class="term">serverino</span></dt><dd><p>Use inode numbers (unique persistent file identifiers)
194
returned by the server instead of automatically generating
195
temporary inode numbers on the client. Although server inode numbers
196
make it easier to spot hardlinked files (as they will have
197
the same inode numbers) and inode numbers may be persistent (which is
198
userful for some sofware),
199
the server does not guarantee that the inode numbers
200
are unique if multiple server side mounts are exported under a
201
single share (since inode numbers on the servers might not
202
be unique if multiple filesystems are mounted under the same
203
shared higher level directory). Note that not all
204
servers support returning server inode numbers, although
205
those that support the CIFS Unix Extensions, and Windows 2000 and
206
later servers typically do support this (although not necessarily
207
on every local server filesystem). Parameter has no effect if
208
the server lacks support for returning inode numbers or equivalent.
209
</p></dd><dt><span class="term">noserverino</span></dt><dd><p>client generates inode numbers (rather than using the actual one
210
from the server) by default.
211
</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
212
can not use rsize larger than CIFSMaxBufSize. CIFSMaxBufSize
213
defaults to 16K and may be changed (from 8K to the maximum
214
kmalloc size allowed by your kernel) at module install time
215
for cifs.ko. Setting CIFSMaxBufSize to a very large value
216
will cause cifs to use more memory and may reduce performance
217
in some cases. To use rsize greater than 127K (the original
218
cifs protocol maximum) also requires that the server support
219
a new Unix Capability flag (for very large read) which some
220
newer servers (e.g. Samba 3.0.26 or later) do. rsize can be
221
set from a minimum of 2048 to a maximum of 130048 (127K or
222
CIFSMaxBufSize, whichever is smaller)
224
</p></dd><dt><span class="term">wsize=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>default network write size (default 57344)
225
maximum wsize currently allowed by CIFS is 57344 (fourteen
226
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="id2481455"></a><h2>SERVICE FORMATTING AND DELIMITERS</h2><p>
227
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.
229
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.
230
</p></div><div class="refsect1" lang="en"><a name="id2481902"></a><h2>ENVIRONMENT VARIABLES</h2><p>
231
The variable <span class="emphasis"><em>USER</em></span> may contain the username of the
232
person to be used to authenticate to the server.
233
The variable can be used to set both username and
234
password by using the format username%password.
236
The variable <span class="emphasis"><em>PASSWD</em></span> may contain the password of the
237
person using the client.
239
The variable <span class="emphasis"><em>PASSWD_FILE</em></span> may contain the pathname
240
of a file to read the password from. A single line of input is
241
read and used as the password.
242
</p></div><div class="refsect1" lang="en"><a name="id2481937"></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="id2481949"></a><h2>CONFIGURATION</h2><p>
243
The primary mechanism for making configuration changes and for reading
244
debug information for the cifs vfs is via the Linux /proc filesystem.
245
In the directory <code class="filename">/proc/fs/cifs</code> are various
246
configuration files and pseudo files which can display debug information.
247
There are additional startup options such as maximum buffer size and number
248
of buffers which only may be set when the kernel cifs vfs (cifs.ko module) is
249
loaded. These can be seen by running the modinfo utility against the file
250
cifs.ko which will list the options that may be passed to cifs during module
251
installation (device driver load).
252
For more information see the kernel file <code class="filename">fs/cifs/README</code>.
253
</p></div><div class="refsect1" lang="en"><a name="id2481982"></a><h2>BUGS</h2><p>Mounting using the CIFS URL specification is currently not supported.
254
</p><p>The credentials file does not handle usernames or passwords with
255
leading space.</p><p>
256
Note that the typical response to a bug report is a suggestion
257
to try the latest version first. So please try doing that first,
258
and always include which versions you use of relevant software
259
when reporting bugs (minimum: mount.cifs (try mount.cifs -V), kernel (see /proc/version) and
260
server type you are trying to contact.
261
</p></div><div class="refsect1" lang="en"><a name="id2482007"></a><h2>VERSION</h2><p>This man page is correct for version 1.52 of
262
the cifs vfs filesystem (roughly Linux kernel 2.6.24).</p></div><div class="refsect1" lang="en"><a name="id2482018"></a><h2>SEE ALSO</h2><p>
263
Documentation/filesystems/cifs.txt and fs/cifs/README in the linux kernel
264
source tree may contain additional options and information.
265
</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="id2532776"></a><h2>AUTHOR</h2><p>Steve French</p><p>The syntax and manpage were loosely based on that of smbmount. It
266
was converted to Docbook/XML by Jelmer Vernooij.</p><p>The maintainer of the Linux cifs vfs and the userspace
267
tool <span class="emphasis"><em>mount.cifs</em></span> is <a class="ulink" href="mailto:sfrench@samba.org" target="_top">Steve French</a>.
268
The <a class="ulink" href="mailto:linux-cifs-client@lists.samba.org" target="_top">Linux CIFS Mailing list</a>
269
is the preferred place to ask questions regarding these programs.
270
</p></div></div></body></html>