| 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.68.1"></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="command">mount.cifs</code> {service} {mount-point} [-o options]</p></div></div><div class="refsect1" lang="en"><a name="id230784"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a 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 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) to |
|---|
| 11 | the local directory <span class="emphasis"><em>mount-point</em></span>. It is possible to set the mode for mount.cifs to |
|---|
| 12 | setuid root to allow non-root users to mount shares to directories for which they |
|---|
| 13 | have write permission. |
|---|
| 14 | </p><p> |
|---|
| 15 | Options to <span class="emphasis"><em>mount.cifs</em></span> are specified as a comma-separated |
|---|
| 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. |
|---|
| 20 | |
|---|
| 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></div><div class="refsect1" lang="en"><a name="id231168"></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 |
|---|
| 24 | this is not given, then the environment variable <span class="emphasis"><em>USER</em></span> is used. This option can also take the |
|---|
| 25 | form "user%password" or "workgroup/user" or |
|---|
| 26 | "workgroup/user%password" to allow the password and workgroup |
|---|
| 27 | to be specified as part of the username. |
|---|
| 28 | </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p> |
|---|
| 29 | 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>. |
|---|
| 30 | </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 |
|---|
| 31 | option is not given then the environment variable |
|---|
| 32 | <span class="emphasis"><em>PASSWD</em></span> is used. If the password is not specified |
|---|
| 33 | directly or indirectly via an argument to mount <span class="emphasis"><em>mount.cifs</em></span> will prompt |
|---|
| 34 | for a password, unless the guest option is specified. |
|---|
| 35 | </p><p>Note that a password which contains the delimiter |
|---|
| 36 | character (i.e. a comma ',') will fail to be parsed correctly |
|---|
| 37 | on the command line. However, the same password defined |
|---|
| 38 | in the PASSWD environment variable or via a credentials file (see |
|---|
| 39 | below) or entered at the password prompt will be read correctly. |
|---|
| 40 | </p></dd><dt><span class="term">credentials=<em class="replaceable"><code>filename</code></em></span></dt><dd><p> |
|---|
| 41 | specifies a file that contains a username |
|---|
| 42 | and/or password. The format of the file is: |
|---|
| 43 | </p><pre class="programlisting"> |
|---|
| 44 | username=<em class="replaceable"><code>value</code></em> |
|---|
| 45 | password=<em class="replaceable"><code>value</code></em> |
|---|
| 46 | </pre><p> |
|---|
| 47 | This is preferred over having passwords in plaintext in a |
|---|
| 48 | shared file, such as <code class="filename">/etc/fstab</code>. Be sure to protect any |
|---|
| 49 | credentials file properly. |
|---|
| 50 | </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 |
|---|
| 51 | the mounted filesystem. |
|---|
| 52 | It may be specified as either a username or a numeric uid. |
|---|
| 53 | This parameter is ignored when the target server supports |
|---|
| 54 | the CIFS Unix extensions.</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 |
|---|
| 55 | the mounted filesystem. |
|---|
| 56 | It may be specified as either a groupname or a numeric |
|---|
| 57 | gid. This parameter is ignored when the target server supports |
|---|
| 58 | the CIFS Unix extensions. |
|---|
| 59 | </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 |
|---|
| 60 | CIFS support. If the CIFS server is not listening on this port or |
|---|
| 61 | if it is not specified, the default ports will be tried i.e. |
|---|
| 62 | port 445 is tried and if no response then port 139 is tried. |
|---|
| 63 | </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 |
|---|
| 64 | source name to use to represent the client netbios machine |
|---|
| 65 | name when doing the RFC1001 netbios session initialize. |
|---|
| 66 | </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 |
|---|
| 67 | 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 |
|---|
| 68 | 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 host or IP address.</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 |
|---|
| 69 | Unicode. Unicode is used by default for network path |
|---|
| 70 | names if the server supports it. If iocharset is |
|---|
| 71 | not specified then the nls_default specified |
|---|
| 72 | during the local client kernel build will be used. |
|---|
| 73 | If server does not support Unicode, this parameter is |
|---|
| 74 | 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 |
|---|
| 75 | the client will attempt to set the effective uid and gid of |
|---|
| 76 | the local process on newly created files, directories, and |
|---|
| 77 | devices (create, mkdir, mknod). If the CIFS Unix Extensions |
|---|
| 78 | are not negotiated, for newly created files and directories |
|---|
| 79 | instead of using the default uid and gid specified on the |
|---|
| 80 | the mount, cache the new file's uid and gid locally which means |
|---|
| 81 | that the uid for the file can change when the inode is |
|---|
| 82 | 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 |
|---|
| 83 | on newly created files, directories, and devices (create, |
|---|
| 84 | mkdir, mknod) which will result in the server setting the |
|---|
| 85 | uid and gid to the default (usually the server uid of the |
|---|
| 86 | user who mounted the share). Letting the server (rather than |
|---|
| 87 | the client) set the uid and gid is the default.If the CIFS |
|---|
| 88 | Unix Extensions are not negotiated then the uid and gid for |
|---|
| 89 | new files will appear to be the uid (gid) of the mounter or the |
|---|
| 90 | 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 |
|---|
| 91 | and gid of the file against the mode and desired operation), |
|---|
| 92 | Note that this is in addition to the normal ACL check on the |
|---|
| 93 | target machine done by the server software. |
|---|
| 94 | 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 |
|---|
| 95 | files on this mount to access by other users on the local |
|---|
| 96 | client system. It is typically only needed when the server |
|---|
| 97 | supports the CIFS Unix Extensions but the UIDs/GIDs on the |
|---|
| 98 | client and server system do not match closely enough to allow |
|---|
| 99 | access by the user doing the mount. |
|---|
| 100 | Note that this does not affect the normal ACL check on the |
|---|
| 101 | target machine done by the server software (of the server |
|---|
| 102 | 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. |
|---|
| 103 | This precludes mmaping files on this mount. In some cases |
|---|
| 104 | with fast networks and little or no caching benefits on the |
|---|
| 105 | client (e.g. when the application is doing large sequential |
|---|
| 106 | reads bigger than page size without rereading the same data) |
|---|
| 107 | this can provide better performance than the default |
|---|
| 108 | behavior which caches reads (readahead) and writes |
|---|
| 109 | (writebehind) through the local Linux client pagecache |
|---|
| 110 | if oplock (caching token) is granted and held. Note that |
|---|
| 111 | direct allows write operations larger than page size |
|---|
| 112 | to be sent to the server. On some kernels this requires the cifs.ko module |
|---|
| 113 | 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) |
|---|
| 114 | to the remap range (above 0xF000), which also |
|---|
| 115 | allows the CIFS client to recognize files created with |
|---|
| 116 | such characters by Windows's POSIX emulation. This can |
|---|
| 117 | also be useful when mounting to most versions of Samba |
|---|
| 118 | (which also forbids creating and opening files |
|---|
| 119 | whose names contain any of these seven characters). |
|---|
| 120 | This has no effect if the server does not support |
|---|
| 121 | 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 |
|---|
| 122 | 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> |
|---|
| 123 | The CIFS client can get and set POSIX ACLs (getfacl, setfacl) to Samba servers |
|---|
| 124 | version 3.10 and later. Setting POSIX ACLs requires enabling both XATTR and |
|---|
| 125 | then POSIX support in the CIFS configuration options when building the cifs |
|---|
| 126 | module. POSIX ACL support can be disabled on a per mount basic by specifying |
|---|
| 127 | "noacl" on mount.</p></dd><dt><span class="term">nocase</span></dt><dd><p>Request case insensitive path name matching (case |
|---|
| 128 | sensitive is the default if the server suports it). |
|---|
| 129 | </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 |
|---|
| 130 | /proc/fs/cifs/PacketSigningEnabled on or if |
|---|
| 131 | 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] |
|---|
| 132 | </p></dd><dt><span class="term">nobrl</span></dt><dd><p>Do not send byte range lock requests to the server. |
|---|
| 133 | This is necessary for certain applications that break |
|---|
| 134 | with cifs style mandatory byte range locks (and most |
|---|
| 135 | cifs servers do not yet support requesting advisory |
|---|
| 136 | byte range locks). |
|---|
| 137 | </p></dd><dt><span class="term">sfu</span></dt><dd><p> |
|---|
| 138 | When the CIFS Unix Extensions are not negotiated, attempt to |
|---|
| 139 | create device files and fifos in a format compatible with |
|---|
| 140 | Services for Unix (SFU). In addition retrieve bits 10-12 |
|---|
| 141 | of the mode via the SETFILEBITS extended attribute (as |
|---|
| 142 | SFU does). In the future the bottom 9 bits of the mode |
|---|
| 143 | mode also will be emulated using queries of the security |
|---|
| 144 | descriptor (ACL). [NB: requires version 1.39 or later |
|---|
| 145 | of the CIFS VFS. To recognize symlinks and be able |
|---|
| 146 | to create symlinks in an SFU interoperable form |
|---|
| 147 | requires version 1.40 or later of the CIFS VFS kernel module. |
|---|
| 148 | </p></dd><dt><span class="term">serverino</span></dt><dd><p>Use inode numbers (unique persistent file identifiers) |
|---|
| 149 | returned by the server instead of automatically generating |
|---|
| 150 | temporary inode numbers on the client. Although server inode numbers |
|---|
| 151 | make it easier to spot hardlinked files (as they will have |
|---|
| 152 | the same inode numbers) and inode numbers may be persistent (which is |
|---|
| 153 | userful for some sofware), |
|---|
| 154 | the server does not guarantee that the inode numbers |
|---|
| 155 | are unique if multiple server side mounts are exported under a |
|---|
| 156 | single share (since inode numbers on the servers might not |
|---|
| 157 | be unique if multiple filesystems are mounted under the same |
|---|
| 158 | shared higher level directory). Note that not all |
|---|
| 159 | servers support returning server inode numbers, although |
|---|
| 160 | those that support the CIFS Unix Extensions, and Windows 2000 and |
|---|
| 161 | later servers typically do support this (although not necessarily |
|---|
| 162 | on every local server filesystem). Parameter has no effect if |
|---|
| 163 | the server lacks support for returning inode numbers or equivalent. |
|---|
| 164 | </p></dd><dt><span class="term">noserverino</span></dt><dd><p>client generates inode numbers (rather than using the actual one |
|---|
| 165 | from the server) by default. |
|---|
| 166 | </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</p></dd><dt><span class="term">wsize=<em class="replaceable"><code>arg</code></em></span></dt><dd><p>default network write size</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="id272078"></a><h2>ENVIRONMENT VARIABLES</h2><p> |
|---|
| 167 | The variable <span class="emphasis"><em>USER</em></span> may contain the username of the |
|---|
| 168 | person to be used to authenticate to the server. |
|---|
| 169 | The variable can be used to set both username and |
|---|
| 170 | password by using the format username%password. |
|---|
| 171 | </p><p> |
|---|
| 172 | The variable <span class="emphasis"><em>PASSWD</em></span> may contain the password of the |
|---|
| 173 | person using the client. |
|---|
| 174 | </p><p> |
|---|
| 175 | The variable <span class="emphasis"><em>PASSWD_FILE</em></span> may contain the pathname |
|---|
| 176 | of a file to read the password from. A single line of input is |
|---|
| 177 | read and used as the password. |
|---|
| 178 | </p></div><div class="refsect1" lang="en"><a name="id272109"></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="id272120"></a><h2>CONFIGURATION</h2><p> |
|---|
| 179 | The primary mechanism for making configuration changes and for reading |
|---|
| 180 | debug information for the cifs vfs is via the Linux /proc filesystem. |
|---|
| 181 | In the directory <code class="filename">/proc/fs/cifs</code> are various |
|---|
| 182 | configuration files and pseudo files which can display debug information. |
|---|
| 183 | There are additional startup options such as maximum buffer size and number |
|---|
| 184 | of buffers which only may be set when the kernel cifs vfs (cifs.ko module) is |
|---|
| 185 | loaded. These can be seen by running the modinfo utility against the file |
|---|
| 186 | cifs.ko which will list the options that may be passed to cifs during module |
|---|
| 187 | installation (device driver load). |
|---|
| 188 | For more information see the kernel file <code class="filename">fs/cifs/README</code>. |
|---|
| 189 | </p></div><div class="refsect1" lang="en"><a name="id272147"></a><h2>BUGS</h2><p>Mounting using the CIFS URL specification is currently not supported. |
|---|
| 190 | </p><p>The credentials file does not handle usernames or passwords with |
|---|
| 191 | leading space.</p><p> |
|---|
| 192 | Note that the typical response to a bug report is a suggestion |
|---|
| 193 | to try the latest version first. So please try doing that first, |
|---|
| 194 | and always include which versions you use of relevant software |
|---|
| 195 | when reporting bugs (minimum: mount.cifs (try mount.cifs -V), kernel (see /proc/version) and |
|---|
| 196 | server type you are trying to contact. |
|---|
| 197 | </p></div><div class="refsect1" lang="en"><a name="id272168"></a><h2>VERSION</h2><p>This man page is correct for version 1.39 of |
|---|
| 198 | the cifs vfs filesystem (roughly Linux kernel 2.6.15).</p></div><div class="refsect1" lang="en"><a name="id272178"></a><h2>SEE ALSO</h2><p> |
|---|
| 199 | Documentation/filesystems/cifs.txt and fs/cifs/README in the linux kernel |
|---|
| 200 | source tree may contain additional options and information. |
|---|
| 201 | </p><p><a 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="id272198"></a><h2>AUTHOR</h2><p>Steve French</p><p>The syntax and manpage were loosely based on that of smbmount. It |
|---|
| 202 | was converted to Docbook/XML by Jelmer Vernooij.</p><p>The maintainer of the Linux cifs vfs and the userspace |
|---|
| 203 | tool <span class="emphasis"><em>mount.cifs</em></span> is <a href="mailto:sfrench@samba.org" target="_top">Steve French</a>. |
|---|
| 204 | The <a href="mailto:linux-cifs-client@lists.samba.org" target="_top">Linux CIFS Mailing list</a> |
|---|
| 205 | is the preferred place to ask questions regarding these programs. |
|---|
| 206 | </p></div></div></body></html> |
|---|
