[tomato.git] / release / src-rt-6.x.4708 / router / samba-3.5.8 / docs / htmldocs / manpages / mount.cifs.8.html
| blob | 068b862447bc0edf57b75abecdd58536b5bc0a0d |
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="id2522927"></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.
9 </p><p>
10 The mount.cifs utility attaches the UNC name (exported network resource)
14 </p><p>
16 list of key=value pairs. It is possible to send options other
17 than those listed here, assuming that the cifs filesystem kernel module (cifs.ko) supports them.
18 Unrecognized cifs mount options passed to the cifs vfs kernel code will be logged to the
19 kernel log.
21 </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
22 the mounted resource is unmounted (usually via the umount utility).
23 </p><p>
24 <span class="emphasis"><em>mount.cifs -V</em></span> command displays the version of cifs mount helper.
25 </p><p>
28 </p></div><div class="refsect1" lang="en"><a name="id2483383"></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
29 this is not given, then the environment variable <span class="emphasis"><em>USER</em></span> is used. This option can also take the
31 "workgroup/user%password" to allow the password and workgroup
32 to be specified as part of the username.
33 </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>
34 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>.
35 </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
36 option is not given then the environment variable
38 directly or indirectly via an argument to mount, <span class="emphasis"><em>mount.cifs</em></span> will prompt
39 for a password, unless the guest option is specified.
40 </p><p>Note that a password which contains the delimiter
41 character (i.e. a comma ',') will fail to be parsed correctly
42 on the command line. However, the same password defined
43 in the PASSWD environment variable or via a credentials file (see
44 below) or entered at the password prompt will be read correctly.
45 </p></dd><dt><span class="term">credentials=<em class="replaceable"><code>filename</code></em></span></dt><dd><p>
46 specifies a file that contains a username
47 and/or password and optionally the name of the
48 workgroup. The format of the file is:
53 </pre><p>
54 This is preferred over having passwords in plaintext in a
56 credentials file properly.
57 </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 or directories on the
58 mounted filesystem when the server does not provide ownership
59 information. It may be specified as either a username or a numeric uid.
60 When not specified, the default is uid 0. The mount.cifs helper must be
61 at version 1.10 or higher to support specifying the uid in non-numeric
62 form. See the section on FILE AND DIRECTORY OWNERSHIP AND PERMISSIONS below for more
63 information. </p></dd><dt><span class="term">forceuid</span></dt><dd><p>instructs the client to ignore any uid provided by
64 the server for files and directories and to always assign the owner to
65 be the value of the uid= option. See the section on FILE AND DIRECTORY OWNERSHIP AND PERMISSIONS below for more information.</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 or
66 directories on the mounted filesystem when the server does not provide
67 ownership information. It may be specified as either a groupname or a
68 numeric gid. When not specified, the default is gid 0. The mount.cifs
69 helper must be at version 1.10 or higher to support specifying the gid
70 in non-numeric form. See the section on FILE AND DIRECTORY OWNERSHIP AND
71 PERMISSIONS below for more information.</p></dd><dt><span class="term">forcegid</span></dt><dd><p>instructs the client to ignore any gid provided by
72 the server for files and directories and to always assign the owner to
73 be the value of the gid= option. See the section on FILE AND DIRECTORY OWNERSHIP AND PERMISSIONS below for more information.</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
74 CIFS support. If the CIFS server is not listening on this port or
75 if it is not specified, the default ports will be tried i.e.
77 </p></dd><dt><span class="term">servern=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>
78 Specify the server netbios name (RFC1001 name) to use
79 when attempting to setup a session to the server. Although
80 rarely needed for mounting to newer servers, this option
81 is needed for mounting to some older servers (such
83 over port 139 they, unlike most newer servers, do not
84 support a default server name. A server name can be up
85 to 15 characters long and is usually uppercased.
86 </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
87 source name to use to represent the client netbios machine
88 name when doing the RFC1001 netbios session initialize.
89 </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
90 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
91 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
92 Unicode. Unicode is used by default for network path
93 names if the server supports it. If iocharset is
94 not specified then the nls_default specified
95 during the local client kernel build will be used.
96 If server does not support Unicode, this parameter is
97 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
98 the client will attempt to set the effective uid and gid of
99 the local process on newly created files, directories, and
100 devices (create, mkdir, mknod). If the CIFS Unix Extensions
101 are not negotiated, for newly created files and directories
102 instead of using the default uid and gid specified on the
103 the mount, cache the new file's uid and gid locally which means
104 that the uid for the file can change when the inode is
105 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
106 on newly created files, directories, and devices (create,
107 mkdir, mknod) which will result in the server setting the
108 uid and gid to the default (usually the server uid of the
109 user who mounted the share). Letting the server (rather than
110 the client) set the uid and gid is the default.If the CIFS
111 Unix Extensions are not negotiated then the uid and gid for
112 new files will appear to be the uid (gid) of the mounter or the
113 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
114 and gid of the file against the mode and desired operation),
115 Note that this is in addition to the normal ACL check on the
116 target machine done by the server software.
117 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
118 files on this mount to access by other users on the local
119 client system. It is typically only needed when the server
120 supports the CIFS Unix Extensions but the UIDs/GIDs on the
121 client and server system do not match closely enough to allow
122 access by the user doing the mount.
123 Note that this does not affect the normal ACL check on the
124 target machine done by the server software (of the server
125 ACL against the user name provided at mount time).</p></dd><dt><span class="term">dynperm</span></dt><dd><p>Instructs the server to maintain ownership and
126 permissions in memory that can't be stored on the server. This information can disappear at any time (whenever the inode is flushed from the cache), so while this may help make some applications work, it's behavior is somewhat unreliable. See the section below on FILE AND DIRECTORY OWNERSHIP AND PERMISSIONS for more information.
127 </p></dd><dt><span class="term">directio</span></dt><dd><p>Do not do inode data caching on files opened on this mount.
128 This precludes mmaping files on this mount. In some cases
129 with fast networks and little or no caching benefits on the
130 client (e.g. when the application is doing large sequential
131 reads bigger than page size without rereading the same data)
132 this can provide better performance than the default
133 behavior which caches reads (readahead) and writes
134 (writebehind) through the local Linux client pagecache
135 if oplock (caching token) is granted and held. Note that
136 direct allows write operations larger than page size
137 to be sent to the server. On some kernels this requires the cifs.ko module
138 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)
139 to the remap range (above 0xF000), which also
140 allows the CIFS client to recognize files created with
141 such characters by Windows's POSIX emulation. This can
142 also be useful when mounting to most versions of Samba
143 (which also forbids creating and opening files
144 whose names contain any of these seven characters).
145 This has no effect if the server does not support
146 Unicode on the wire. Please note that the files created
147 with mapchars mount option may not be accessible
148 if the share is mounted without that option.</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
149 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>
150 The CIFS client can get and set POSIX ACLs (getfacl, setfacl) to Samba servers
151 version 3.0.10 and later. Setting POSIX ACLs requires enabling both XATTR and
152 then POSIX support in the CIFS configuration options when building the cifs
153 module. POSIX ACL support can be disabled on a per mount basis by specifying
154 "noacl" on mount.</p></dd><dt><span class="term">nocase</span></dt><dd><p>Request case insensitive path name matching (case
155 sensitive is the default if the server suports it).
156 </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
157 /proc/fs/cifs/PacketSigningEnabled on or if
158 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]
159 </p></dd><dt><span class="term">nobrl</span></dt><dd><p>Do not send byte range lock requests to the server.
160 This is necessary for certain applications that break
161 with cifs style mandatory byte range locks (and most
162 cifs servers do not yet support requesting advisory
163 byte range locks).
165 When the CIFS Unix Extensions are not negotiated, attempt to
166 create device files and fifos in a format compatible with
168 of the mode via the SETFILEBITS extended attribute (as
169 SFU does). In the future the bottom 9 bits of the mode
170 mode also will be emulated using queries of the security
171 descriptor (ACL). [NB: requires version 1.39 or later
172 of the CIFS VFS. To recognize symlinks and be able
173 to create symlinks in an SFU interoperable form
174 requires version 1.40 or later of the CIFS VFS kernel module.
175 </p></dd><dt><span class="term">serverino</span></dt><dd><p>Use inode numbers (unique persistent file identifiers)
176 returned by the server instead of automatically generating
177 temporary inode numbers on the client. Although server inode numbers
178 make it easier to spot hardlinked files (as they will have
179 the same inode numbers) and inode numbers may be persistent (which is
180 userful for some sofware),
181 the server does not guarantee that the inode numbers
182 are unique if multiple server side mounts are exported under a
183 single share (since inode numbers on the servers might not
184 be unique if multiple filesystems are mounted under the same
185 shared higher level directory). Note that not all
186 servers support returning server inode numbers, although
187 those that support the CIFS Unix Extensions, and Windows 2000 and
188 later servers typically do support this (although not necessarily
189 on every local server filesystem). Parameter has no effect if
190 the server lacks support for returning inode numbers or equivalent.
192 Client generates inode numbers (rather than
193 using the actual one from the server) by default.
194 </p><p>
196 more information.
198 Disable the CIFS Unix Extensions for this mount. This
199 can be useful in order to turn off multiple settings at once.
200 This includes POSIX acls, POSIX locks, POSIX paths, symlink
201 support and retrieving uids/gids/mode from the server. This
202 can also be useful to work around a bug in a server that
203 supports Unix Extensions.
204 </p><p>
206 more information.
207 </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
208 can not use rsize larger than CIFSMaxBufSize. CIFSMaxBufSize
210 kmalloc size allowed by your kernel) at module install time
211 for cifs.ko. Setting CIFSMaxBufSize to a very large value
212 will cause cifs to use more memory and may reduce performance
213 in some cases. To use rsize greater than 127K (the original
214 cifs protocol maximum) also requires that the server support
215 a new Unix Capability flag (for very large read) which some
216 newer servers (e.g. Samba 3.0.26 or later) do. rsize can be
218 CIFSMaxBufSize, whichever is smaller)
220 </p></dd><dt><span class="term">wsize=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>default network write size (default 57344)
221 maximum wsize currently allowed by CIFS is 57344 (fourteen
222 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="id2532669"></a><h2>SERVICE FORMATTING AND DELIMITERS</h2><p>
223 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.
224 </p><p>
225 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.
227 When Unix Extensions are enabled, we use the actual inode
228 number provided by the server in response to the POSIX calls as an
229 inode number.
230 </p><p>
231 When Unix Extensions are disabled and "serverino" mount option
232 is enabled there is no way to get the server inode number. The
233 client typically maps the server-assigned "UniqueID" onto an inode
234 number.
235 </p><p>
236 Note that the UniqueID is a different value from the server
237 inode number. The UniqueID value is unique over the scope of the entire
239 programs that are not compiled with LFS (Large File Support), to
240 trigger a glibc EOVERFLOW error as this won't fit in the target
241 structure field. It is strongly recommended to compile your programs
242 with LFS support (i.e. with -D_FILE_OFFSET_BITS=64) to prevent this
243 problem. You can also use "noserverino" mount option to generate inode
245 to detect hardlinks properly.
246 </p></div><div class="refsect1" lang="en"><a name="id2532725"></a><h2>FILE AND DIRECTORY OWNERSHIP AND PERMISSIONS</h2><p> The core CIFS protocol does not provide unix ownership
247 information or mode for files and directories. Because of this, files
248 and directories will generally appear to be owned by whatever values the
249 uid= or gid= options are set, and will have permissions set to the
250 default file_mode and dir_mode for the mount. Attempting to change these
251 values via chmod/chown will return success but have no effect.</p><p>When the client and server negotiate unix extensions,
252 files and directories will be assigned the uid, gid, and mode provided
253 by the server. Because CIFS mounts are generally single-user, and the
254 same credentials are used no matter what user accesses the mount, newly
255 created files and directories will generally be given ownership
256 corresponding to whatever credentials were used to mount the
257 share.</p><p>If the uid's and gid's being used do not match on the
258 client and server, the forceuid and forcegid options may be helpful.
259 Note however, that there is no corresponding option to override the
260 mode. Permissions assigned to a file when forceuid or forcegid are in
261 effect may not reflect the the real permissions.</p><p>When unix extensions are not negotiated, it's also
262 possible to emulate them locally on the server using the "dynperm" mount
263 option. When this mount option is in effect, newly created files and
264 directories will receive what appear to be proper permissions. These
265 permissions are not stored on the server however and can disappear at
266 any time in the future (subject to the whims of the kernel flushing out
267 the inode cache). In general, this mount option is discouraged.
268 </p><p>It's also possible to override permission checking on the client
269 altogether via the noperm option. Server-side permission checks cannot be
270 overriden. The permission checks done by the server will always correspond to
271 the credentials used to mount the share, and not necessarily to the user who is accessing the share.</p></div><div class="refsect1" lang="en"><a name="id2532781"></a><h2>ENVIRONMENT VARIABLES</h2><p>
273 person to be used to authenticate to the server.
274 The variable can be used to set both username and
275 password by using the format username%password.
276 </p><p>
278 person using the client.
279 </p><p>
281 of a file to read the password from. A single line of input is
282 read and used as the password.
283 </p></div><div class="refsect1" lang="en"><a name="id2532813"></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. When installed as a setuid program, the program follows the conventions set forth by the mount program for user mounts.</p><p>
284 Some samba client tools like smbclient(8) honour client-side
285 configuration parameters present in smb.conf. Unlike those
287 completely.
289 The primary mechanism for making configuration changes and for reading
290 debug information for the cifs vfs is via the Linux /proc filesystem.
292 configuration files and pseudo files which can display debug information.
293 There are additional startup options such as maximum buffer size and number
294 of buffers which only may be set when the kernel cifs vfs (cifs.ko module) is
295 loaded. These can be seen by running the modinfo utility against the file
296 cifs.ko which will list the options that may be passed to cifs during module
297 installation (device driver load).
299 </p></div><div class="refsect1" lang="en"><a name="id2532866"></a><h2>BUGS</h2><p>Mounting using the CIFS URL specification is currently not supported.
300 </p><p>The credentials file does not handle usernames or passwords with
301 leading space.</p><p>
302 Note that the typical response to a bug report is a suggestion
303 to try the latest version first. So please try doing that first,
304 and always include which versions you use of relevant software
305 when reporting bugs (minimum: mount.cifs (try mount.cifs -V), kernel (see /proc/version) and
306 server type you are trying to contact.
307 </p></div><div class="refsect1" lang="en"><a name="id2532891"></a><h2>VERSION</h2><p>This man page is correct for version 1.52 of
308 the cifs vfs filesystem (roughly Linux kernel 2.6.24).</p></div><div class="refsect1" lang="en"><a name="id2532902"></a><h2>SEE ALSO</h2><p>
309 Documentation/filesystems/cifs.txt and fs/cifs/README in the linux kernel
310 source tree may contain additional options and information.
311 </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="id2532923"></a><h2>AUTHOR</h2><p>Steve French</p><p>The syntax and manpage were loosely based on that of smbmount. It
312 was converted to Docbook/XML by Jelmer Vernooij.</p><p>The maintainer of the Linux cifs vfs and the userspace
313 tool <span class="emphasis"><em>mount.cifs</em></span> is <a class="ulink" href="mailto:sfrench@samba.org" target="_top">Steve French</a>.
314 The <a class="ulink" href="mailto:linux-cifs-client@lists.samba.org" target="_top">Linux CIFS Mailing list</a>
315 is the preferred place to ask questions regarding these programs.
316 </p></div></div></body></html>