~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/Documentation/admin-guide/cifs/usage.rst

Version: ~ [ linux-6.11.5 ] ~ [ linux-6.10.14 ] ~ [ linux-6.9.12 ] ~ [ linux-6.8.12 ] ~ [ linux-6.7.12 ] ~ [ linux-6.6.58 ] ~ [ linux-6.5.13 ] ~ [ linux-6.4.16 ] ~ [ linux-6.3.13 ] ~ [ linux-6.2.16 ] ~ [ linux-6.1.114 ] ~ [ linux-6.0.19 ] ~ [ linux-5.19.17 ] ~ [ linux-5.18.19 ] ~ [ linux-5.17.15 ] ~ [ linux-5.16.20 ] ~ [ linux-5.15.169 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.228 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.284 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.322 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.336 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.337 ] ~ [ linux-4.4.302 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.9 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

Diff markup

Differences between /Documentation/admin-guide/cifs/usage.rst (Version linux-6.11.5) and /Documentation/admin-guide/cifs/usage.rst (Version linux-5.1.21)


  1 =====                                             
  2 Usage                                             
  3 =====                                             
  4                                                   
  5 This module supports the SMB3 family of advanc    
  6 as older dialects, originally called "CIFS" or    
  7                                                   
  8 The CIFS VFS module for Linux supports many ad    
  9 features such as hierarchical DFS like namespa    
 10 It was designed to comply with the SNIA CIFS T    
 11 supersedes the 1992 X/Open SMB Standard) as we    
 12 practical interoperability with Windows 2000,     
 13 servers.  This code was developed in participa    
 14 Information Foundation.  CIFS and now SMB3 has    
 15 standard for interoperating between Macs and W    
 16                                                   
 17 Please see                                        
 18 MS-SMB2 (for detailed SMB2/SMB3/SMB3.1.1 proto    
 19 or https://samba.org/samba/PFIF/                  
 20 for more details.                                 
 21                                                   
 22                                                   
 23 For questions or bug reports please contact:      
 24                                                   
 25     smfrench@gmail.com                            
 26                                                   
 27 See the project page at: https://wiki.samba.or    
 28                                                   
 29 Build instructions                                
 30 ==================                                
 31                                                   
 32 For Linux:                                        
 33                                                   
 34 1) Download the kernel (e.g. from https://www.    
 35    and change directory into the top of the ke    
 36    (e.g. /usr/src/linux-2.5.73)                   
 37 2) make menuconfig (or make xconfig)              
 38 3) select cifs from within the network filesys    
 39 4) save and exit                                  
 40 5) make                                           
 41                                                   
 42                                                   
 43 Installation instructions                         
 44 =========================                         
 45                                                   
 46 If you have built the CIFS vfs as module (succ    
 47 type ``make modules_install`` (or if you prefe    
 48 the modules directory e.g. /lib/modules/6.3.0-    
 49                                                   
 50 If you have built the CIFS vfs into the kernel    
 51 for your distribution on how to install a new     
 52 would simply type ``make install``).              
 53                                                   
 54 If you do not have the utility mount.cifs (in     
 55 the CIFS VFS web site) copy it to the same dir    
 56 reside (usually /sbin).  Although the helper s    
 57 required, mount.cifs is recommended.  Most dis    
 58 package that includes this utility so it is re    
 59                                                   
 60 Note that running the Winbind pam/nss module (    
 61 Linux clients is useful in mapping Uids and Gi    
 62 domain to the proper network user.  The mount.    
 63 found at cifs-utils.git on git.samba.org          
 64                                                   
 65 If cifs is built as a module, then the size an    
 66 and maximum number of simultaneous requests to    
 67 Changing these from their defaults is not reco    
 68                                                   
 69         modinfo <path to cifs.ko>                 
 70                                                   
 71 on kernel/fs/smb/client/cifs.ko the list of co    
 72 at module initialization time (by running insm    
 73                                                   
 74 Recommendations                                   
 75 ===============                                   
 76                                                   
 77 To improve security the SMB2.1 dialect or late    
 78 the new default. To use old dialects (e.g. to     
 79 on mount (or vers=2.0 for Windows Vista).  Not    
 80 much older and less secure than the default di    
 81 many advanced security features such as downgr    
 82 and encrypted shares and stronger signing and     
 83 There are additional mount options that may be    
 84 improved POSIX behavior (NB: can use vers=3 to    
 85                                                   
 86    ``mfsymlinks`` and either ``cifsacl`` or ``    
 87                                                   
 88 Allowing User Mounts                              
 89 ====================                              
 90                                                   
 91 To permit users to mount and unmount over dire    
 92 with the cifs vfs.  A way to enable such mount    
 93 utility as suid (e.g. ``chmod +s /sbin/mount.c    
 94 umount shares they mount requires                 
 95                                                   
 96 1) mount.cifs version 1.4 or later                
 97 2) an entry for the share in /etc/fstab indica    
 98    unmount it e.g.::                              
 99                                                   
100      //server/usersharename  /mnt/username cif    
101                                                   
102 Note that when the mount.cifs utility is run s    
103 in order to reduce risks, the ``nosuid`` mount    
104 disallow execution of an suid program mounted     
105 When mount is executed as root, nosuid is not     
106 and execution of suid programs on the remote t    
107 by default. This can be changed, as with nfs a    
108 by simply specifying ``nosuid`` among the moun    
109 though to be able to pass the suid flag to mou    
110 mount.cifs with the following flag: CIFS_ALLOW    
111                                                   
112 There is a corresponding manual page for cifs     
113 later source tree in docs/manpages/mount.cifs.    
114                                                   
115 Allowing User Unmounts                            
116 ======================                            
117                                                   
118 To permit users to unmount directories that th    
119 the utility umount.cifs may be used.  It may b    
120 umount.cifs is placed in /sbin, umount can inv    
121 (at least for most versions of the umount util    
122 mounts, unless umount is invoked with -i (whic    
123 helper). As with mount.cifs, to enable user un    
124 as suid (e.g. ``chmod +s /sbin/umount.cifs``)     
125 allow adding entries to a file to the /etc/per    
126 equivalent suid effect).  For this utility to     
127 must be a cifs mount, and the uid of the curre    
128 of the user who mounted the resource.             
129                                                   
130 Also note that the customary way of allowing u    
131 (instead of using mount.cifs and unmount.cifs     
132 to the file /etc/fstab for each //server/share    
133 this can become unwieldy when potential mount     
134 or  unpredictable UNC names.                      
135                                                   
136 Samba Considerations                              
137 ====================                              
138                                                   
139 Most current servers support SMB2.1 and SMB3 w    
140 but there are useful protocol extensions for t    
141 dialect, so to get the maximum benefit if moun    
142 (CIFS/SMB1), we recommend using a server that     
143 Unix Extensions standard (e.g. almost any  ver    
144 2.2.5 or later) but the CIFS vfs works fine wi    
145 Note that uid, gid and file permissions will d    
146 not have a server that supports the Unix exten    
147 2.2.5 or later).  To enable the Unix CIFS Exte    
148 the line::                                        
149                                                   
150         unix extensions = yes                     
151                                                   
152 to your smb.conf file on the server.  Note tha    
153 are also useful (on the Samba server) when the    
154 Linux::                                           
155                                                   
156         case sensitive = yes                      
157         delete readonly = yes                     
158         ea support = yes                          
159                                                   
160 Note that server ea support is required for su    
161 cifs client, and that EA support is present in    
162 3.0.6 and later (also EA support works in all     
163 shares on NTFS filesystems).  Extended Attribu    
164 feature of most Linux filesystems which may re    
165 make menuconfig. Client support for extended a    
166 disabled on a per-mount basis by specifying ``    
167                                                   
168 The CIFS client can get and set POSIX ACLs (ge    
169 version 3.10 and later.  Setting POSIX ACLs re    
170 then POSIX support in the CIFS configuration o    
171 module.  POSIX ACL support can be disabled on     
172 ``noacl`` on mount.                               
173                                                   
174 Some administrators may want to change Samba's    
175 ``create mask`` parameters from the default.      
176 newly created files can end up with an unneces    
177 which may not be what you want, although if th    
178 enabled on the server and client, subsequent s    
179 fix the mode.  Note that creating special devi    
180 may require specifying a mkdev function to Sam    
181 Samba 3.0.6 or later.  For more information on    
182 (``man smb.conf``) on the Samba server system.    
183 unlike the smbfs vfs, does not read the smb.co    
184 (the few optional settings are passed in on mo    
185 Note that Samba 2.2.7 or later includes a fix     
186 open files (required for strict POSIX complian    
187 supported this feature. Samba server does not     
188 outside of the share, so in Samba versions pri    
189 files with absolute paths (ie beginning with s    
190                                                   
191          ln -s /mnt/foo bar                       
192                                                   
193 would be forbidden. Samba 3.0.6 server or late    
194 such symlinks safely by converting unsafe syml    
195 files that are outside of the share) to a samb    
196 that is ignored by local server applications a    
197 not be traversed by the Samba server).  This i    
198 application using the cifs vfs. Absolute symli    
199 later, but only for remote clients using the C    
200 be invisible to Windows clients and typically     
201 applications running on the same server as Sam    
202                                                   
203 Use instructions                                  
204 ================                                  
205                                                   
206 Once the CIFS VFS support is built into the ke    
207 (cifs.ko), you can use mount syntax like the f    
208 Mac or Windows servers::                          
209                                                   
210   mount -t cifs //9.53.216.11/e$ /mnt -o usern    
211                                                   
212 Before -o the option -v may be specified to ma    
213 mount helper display the mount steps more verb    
214 After -o the following commonly used cifs vfs     
215 are supported::                                   
216                                                   
217   username=<username>                             
218   password=<password>                             
219   domain=<domain name>                            
220                                                   
221 Other cifs mount options are described below.     
222 ip addresses) is available if the mount helper    
223 you do not trust the server to which are mount    
224 cifs signing enabled (and the physical network    
225 of the standard mount options ``noexec`` and `    
226 running an altered binary on your local system    
227 or altered by a hostile router).                  
228                                                   
229 Although mounting using format corresponding t    
230 not possible in mount.cifs yet, it is possible    
231 for the server and sharename (which is somewha    
232 syntax) instead of the more widely used UNC fo    
233                                                   
234   mount -t cifs tcp_name_of_server:share_name     
235                                                   
236 When using the mount helper mount.cifs, passwo    
237 mechanisms, instead of specifying it after -o     
238 on the command line:                              
239 1) By including it in a credential file. Speci    
240 of the mount options. Credential files contain    
241                                                   
242         username=someuser                         
243         password=your_password                    
244                                                   
245 2) By specifying the password in the PASSWD en    
246    the user name can be taken from the USER en    
247 3) By specifying the password in a file by nam    
248 4) By specifying the password in a file by fil    
249                                                   
250 If no password is provided, mount.cifs will pr    
251                                                   
252 Restrictions                                      
253 ============                                      
254                                                   
255 Servers must support either "pure-TCP" (port 4    
256 1001/1002 support for "Netbios-Over-TCP/IP." T    
257 problem as most servers support this.             
258                                                   
259 Valid filenames differ between Windows and Lin    
260 filenames which contain certain reserved chara    
261 which is used to delimit the beginning of a st    
262 Linux allows a slightly wider set of valid cha    
263 servers can remap such characters when an expl    
264 the Server's registry.  Samba starting with ve    
265 filenames (ie those which contain valid Linux     
266 would be forbidden for Windows/CIFS semantics)    
267 configured for Unix Extensions (and the client    
268 /proc/fs/cifs/LinuxExtensionsEnabled). In addi    
269 ``mapposix`` can be used on CIFS (vers=1.0) to    
270 illegal Windows/NTFS/SMB characters to a remap    
271 is the default for SMB3). This remap (``mappos    
272 compatible with Mac (and "Services for Mac" on    
273                                                   
274 CIFS VFS Mount Options                            
275 ======================                            
276 A partial list of the supported mount options     
277                                                   
278   username                                        
279                 The user name to use when tryi    
280                 the CIFS session.                 
281   password                                        
282                 The user password.  If the mou    
283                 installed, the user will be pr    
284                 if not supplied.                  
285   ip                                              
286                 The ip address of the target s    
287   unc                                             
288                 The target server Universal Ne    
289                 mount.                            
290   domain                                          
291                 Set the SMB/CIFS workgroup nam    
292                 username during CIFS session e    
293   forceuid                                        
294                 Set the default uid for inodes    
295                 passed in on mount. For mounts    
296                 which do support the CIFS Unix    
297                 properly configured Samba serv    
298                 the uid, gid and mode so this     
299                 specified unless the server an    
300                 numbering differ.  If the serv    
301                 same domain (e.g. running winb    
302                 the server supports the Unix E    
303                 and gid can be retrieved from     
304                 and gid would not have to be s    
305                 For servers which do not suppo    
306                 extensions, the default uid (a    
307                 of existing files will be the     
308                 who executed the mount (root,     
309                 is configured setuid for user     
310                 (gid) mount option is specifie    
311                 checks (authorization checks)     
312                 at the server, but there are c    
313                 may want to restrict at the cl    
314                 servers which do not report a     
315                 (such as Windows), permissions    
316                 client, and a crude form of cl    
317                 can be enabled by specifying f    
318                 the client.  (default)            
319   forcegid                                        
320                 (similar to above but for the     
321   noforceuid                                      
322                 Fill in file owner information    
323                 the server if possible. With t    
324                 the uid= option (on mount) wil    
325                 can not support returning uids    
326   noforcegid                                      
327                 (similar to above but for the     
328   uid                                             
329                 Set the default uid for inodes    
330                 cifs kernel driver which local    
331                 supports the unix extensions t    
332                 not used to fill in the owner     
333                 unless the ``forceuid`` parame    
334   gid                                             
335                 Set the default gid for inodes    
336   file_mode                                       
337                 If CIFS Unix extensions are no    
338                 this overrides the default mod    
339   fsc                                             
340                 Enable local disk caching usin    
341                 option could be useful to impr    
342                 heavily loaded server and/or n    
343                 disk is faster than reading fr    
344                 This could also impact scalabi    
345                 number of calls to the server     
346                 caching is not suitable for al    
347                 type workloads. So, you need t    
348                 workload/scenario before using    
349                 disk caching is functional for    
350   dir_mode                                        
351                 If CIFS Unix extensions are no    
352                 this overrides the default mod    
353   port                                            
354                 attempt to contact the server     
355                 trying the usual ports (port 4    
356   iocharset                                       
357                 Codepage used to convert local    
358                 Unicode. Unicode is used by de    
359                 names if the server supports i    
360                 not specified then the nls_def    
361                 during the local client kernel    
362                 If server does not support Uni    
363                 unused.                           
364   rsize                                           
365                 default read size (usually 16K    
366                 can not use rsize larger than     
367                 defaults to 16K and may be cha    
368                 kmalloc size allowed by your k    
369                 for cifs.ko. Setting CIFSMaxBu    
370                 will cause cifs to use more me    
371                 in some cases.  To use rsize g    
372                 cifs protocol maximum) also re    
373                 a new Unix Capability flag (fo    
374                 newer servers (e.g. Samba 3.0.    
375                 set from a minimum of 2048 to     
376                 CIFSMaxBufSize, whichever is s    
377   wsize                                           
378                 default write size (default 57    
379                 maximum wsize currently allowe    
380                 4096 byte pages)                  
381   actimeo=n                                       
382                 attribute cache timeout in sec    
383                 After this timeout, the cifs c    
384                 information from the server. T    
385                 attribute cache timeout to sui    
386                 timeouts mean better the cache    
387                 of calls to the server. Longer    
388                 of calls to the server at the     
389                 coherency checks (i.e. incorre    
390                 period of time).                  
391   rw                                              
392                 mount the network share read-w    
393                 server may still consider the     
394   ro                                              
395                 mount network share read-only     
396   version                                         
397                 used to distinguish different     
398                 mount helper utility (not typi    
399   sep                                             
400                 if first mount option (after t    
401                 the comma as the separator bet    
402                 parameters. e.g.::                
403                                                   
404                         -o user=myname,passwor    
405                                                   
406                 could be passed instead with p    
407                                                   
408                         -o sep=.user=myname.pa    
409                                                   
410                 this might be useful when comm    
411                 or password or domain. This op    
412                 when the cifs mount helper cif    
413                 is used.                          
414   nosuid                                          
415                 Do not allow remote executable    
416                 program to be executed.  This     
417                 to servers such as Samba which    
418                 If you do not trust the server    
419                 targets) it is recommended tha    
420                 greater security.                 
421   exec                                            
422                 Permit execution of binaries o    
423   noexec                                          
424                 Do not permit execution of bin    
425   dev                                             
426                 Recognize block devices on the    
427   nodev                                           
428                 Do not recognize devices on th    
429   suid                                            
430                 Allow remote files on this mou    
431                 be executed (default for mount    
432                 nosuid is default for user mou    
433   credentials                                     
434                 Although ignored by the cifs k    
435                 the mount helper, mount.cifs.     
436                 opens and reads the credential    
437                 to obtain the userid and passw    
438                 the cifs vfs.                     
439   guest                                           
440                 Although ignored by the kernel    
441                 mount helper will not prompt t    
442                 if guest is specified on the m    
443                 password is specified a null p    
444   perm                                            
445                 Client does permission checks     
446                 and gid of the file against th    
447                 Note that this is in addition     
448                 target machine done by the ser    
449                 Client permission checking is     
450   noperm                                          
451                 Client does not do permission     
452                 files on this mount to access     
453                 client system. It is typically    
454                 supports the CIFS Unix Extensi    
455                 client and server system do no    
456                 access by the user doing the m    
457                 non CIFS Unix Extension mounts    
458                 mode is specified on the mount    
459                 client (e.g. perhaps when Mult    
460                 Note that this does not affect    
461                 target machine done by the ser    
462                 ACL against the user name prov    
463   serverino                                       
464                 Use server's inode numbers ins    
465                 incrementing inode numbers on     
466                 make it easier to spot hardlin    
467                 the same inode numbers) and in    
468                 note that the server does not     
469                 are unique if multiple server     
470                 single share (since inode numb    
471                 be unique if multiple filesyst    
472                 shared higher level directory)    
473                 (e.g. pre-Windows 2000) do not    
474                 or the CIFS Unix Extensions eq    
475                 this mount option will have no    
476                 under nfsd requires this mount    
477                 This is now the default if ser    
478                 required network operation.       
479   noserverino                                     
480                 Client generates inode numbers    
481                 from the server). These inode     
482                 unmount or reboot which can co    
483                 but not all server filesystems    
484                 numbers.                          
485   setuids                                         
486                 If the CIFS Unix extensions ar    
487                 the client will attempt to set    
488                 the local process on newly cre    
489                 devices (create, mkdir, mknod)    
490                 are not negotiated, for newly     
491                 instead of using the default u    
492                 the mount, cache the new file'    
493                 that the uid for the file can     
494                 reloaded (or the user remounts    
495   nosetuids                                       
496                 The client will not attempt to    
497                 on newly created files, direct    
498                 mkdir, mknod) which will resul    
499                 uid and gid to the default (us    
500                 user who mounted the share).      
501                 the client) set the uid and gi    
502                 Unix Extensions are not negoti    
503                 new files will appear to be th    
504                 uid (gid) parameter specified     
505   netbiosname                                     
506                 When mounting to servers via p    
507                 source name to use to represen    
508                 name when doing the RFC1001 ne    
509   direct                                          
510                 Do not do inode data caching o    
511                 This precludes mmapping files     
512                 with fast networks and little     
513                 client (e.g. when the applicat    
514                 reads bigger than page size wi    
515                 this can provide better perfor    
516                 behavior which caches reads (r    
517                 (writebehind) through the loca    
518                 if oplock (caching token) is g    
519                 direct allows write operations    
520                 to be sent to the server.         
521   strictcache                                     
522                 Use for switching on strict ca    
523                 client read from the cache all    
524                 otherwise - read from the serv    
525                 in the cache, but if the clien    
526                 it writes the data to the serv    
527   rwpidforward                                    
528                 Forward pid of a process who o    
529                 operation on that file. This p    
530                 from failing on read and write    
531   acl                                             
532                 Allow setfacl and getfacl to m    
533                 supports them.  (default)         
534   noacl                                           
535                 Do not allow setfacl and getfa    
536   user_xattr                                      
537                 Allow getting and setting user    
538                 name begins with ``user.`` or     
539                 attributes) to the server.  Th    
540                 setfattr and getfattr utilitie    
541   nouser_xattr                                    
542                 Do not allow getfattr/setfattr    
543   mapchars                                        
544                 Translate six of the seven res    
545                                                   
546                         *?<>|:                    
547                                                   
548                 to the remap range (above 0xF0    
549                 allows the CIFS client to reco    
550                 such characters by Windows's P    
551                 also be useful when mounting t    
552                 (which also forbids creating a    
553                 whose names contain any of the    
554                 This has no effect if the serv    
555                 Unicode on the wire.              
556   nomapchars                                      
557                 Do not translate any of these     
558   nocase                                          
559                 Request case insensitive path     
560                 sensitive is the default if th    
561                 (mount option ``ignorecase`` i    
562   posixpaths                                      
563                 If CIFS Unix extensions are su    
564                 negotiate posix path name supp    
565                 characters forbidden in typica    
566                 requiring remapping. (default)    
567   noposixpaths                                    
568                 If CIFS Unix extensions are su    
569                 posix path name support (this     
570                 reject creatingfile with certa    
571   nounix                                          
572                 Disable the CIFS Unix Extensio    
573                 connection). This is rarely ne    
574                 in order to turn off multiple     
575                 posix acls, posix locks, posix    
576                 and retrieving uids/gids/mode     
577                 work around a bug in server wh    
578                 Extensions.                       
579   nobrl                                           
580                 Do not send byte range lock re    
581                 This is necessary for certain     
582                 with cifs style mandatory byte    
583                 cifs servers do not yet suppor    
584                 byte range locks).                
585   forcemandatorylock                              
586                 Even if the server supports po    
587                 locking, send only mandatory l    
588                 (presumably rare) applications    
589                 DOS/Windows, which require Win    
590                 locking, they may be able to t    
591                 forcing the cifs client to onl    
592                 even if the cifs server would     
593                 ``forcemand`` is accepted as a    
594                 option.                           
595   nostrictsync                                    
596                 If this mount option is set, w    
597                 fsync call then the cifs clien    
598                 to the server (to force the se    
599                 for this file immediately to d    
600                 all dirty (cached) file data t    
601                 server to respond to the write    
602                 very slow, and some servers ma    
603                 delaying slightly flushing the    
604                 turning on this option may be     
605                 applications that fsync too mu    
606                 crash.  If this mount option i    
607                 send an SMB flush request (and    
608                 fsync call.                       
609   nodfs                                           
610                 Disable DFS (global name space    
611                 server claims to support it.      
612                 a problem with parsing of DFS     
613                 versions 3.0.24 and 3.0.25.       
614   remount                                         
615                 remount the share (often used     
616                 or vice versa)                    
617   cifsacl                                         
618                 Report mode bits (e.g. on stat    
619                 the file. (EXPERIMENTAL)          
620   servern                                         
621                 Specify the server 's netbios     
622                 when attempting to setup a ses    
623                 This is needed for mounting to    
624                 as OS/2 or Windows 98 and Wind    
625                 support a default server name.    
626                 to 15 characters long and is u    
627   sfu                                             
628                 When the CIFS Unix Extensions     
629                 create device files and fifos     
630                 Services for Unix (SFU).  In a    
631                 of the mode via the SETFILEBIT    
632                 SFU does).  In the future the     
633                 mode also will be emulated usi    
634                 descriptor (ACL).                 
635   mfsymlinks                                      
636                 Enable support for Minshall+Fr    
637                 (see http://wiki.samba.org/ind    
638                 This option is ignored when sp    
639                 'sfu' option. Minshall+French     
640                 the server supports the CIFS U    
641   sign                                            
642                 Must use packet signing (helps    
643                 by intermediate systems in the    
644                 does not work with lanman or p    
645   seal                                            
646                 Must seal (encrypt) all data o    
647                 sending on the network.  Requi    
648                 Note that this differs from th    
649                 causes encryption of data sent    
650                 shares mounted to the same ser    
651   locallease                                      
652                 This option is rarely needed.     
653                 used by some applications such    
654                 check to see whether a file is    
655                 to explicitly request a lease,    
656                 is cacheable (oplocked).  Unfo    
657                 is not oplocked, it could stil    
658                 could grant fcntl leases if no    
659                 the file) for cases for exampl    
660                 support oplocks and the user i    
661                 the file will be from this cli    
662                 will allow the cifs client to     
663                 for files which are not oplock    
664                 in that case. (EXPERIMENTAL)      
665   sec                                             
666                 Security mode.  Allowed values    
667                                                   
668                         none                      
669                                 attempt to con    
670                         krb5                      
671                                 Use Kerberos v    
672                         krb5i                     
673                                 Use Kerberos a    
674                         ntlm                      
675                                 Use NTLM passw    
676                         ntlmi                     
677                                 Use NTLM passw    
678                                 /proc/fs/cifs/    
679                                 server require    
680                         ntlmv2                    
681                                 Use NTLMv2 pas    
682                         ntlmv2i                   
683                                 Use NTLMv2 pas    
684                         lanman                    
685                                 (if configured    
686                                 lanman hash       
687   hard                                            
688                 Retry file operations if serve    
689   soft                                            
690                 Limit retries to unresponsive     
691                 one retry) before returning an    
692                                                   
693 The mount.cifs mount helper also accepts a few    
694 including:                                        
695                                                   
696 =============== ==============================    
697         -S      take password from stdin (equi    
698                 variable ``PASSWD_FD=0``          
699         -V      print mount.cifs version          
700         -?      display simple usage informati    
701 =============== ==============================    
702                                                   
703 With most 2.6 kernel versions of modutils, the    
704 module can be displayed via modinfo.              
705                                                   
706 Misc /proc/fs/cifs Flags and Debug Info           
707 =======================================           
708                                                   
709 Informational pseudo-files:                       
710                                                   
711 ======================= ======================    
712 DebugData               Displays information a    
713                         shares, features enabl    
714                         version.                  
715 Stats                   Lists summary resource    
716                         share statistics.         
717 open_files              List all the open file    
718 mount_params            List of all mount para    
719 ======================= ======================    
720                                                   
721 Configuration pseudo-files:                       
722                                                   
723 ======================= ======================    
724 SecurityFlags           Flags which control se    
725                         also packet signing. A    
726                         flags (e.g. for NTLMv2    
727                         the signing flags.  Sp    
728                         hashing mechanisms (as    
729                         does not make much sen    
730                                                   
731                                 0x00C5            
732                                                   
733                         (NTLMv2 and packet sig    
734                         may require enabling a    
735                                                   
736                           may use packet signi    
737                           must use packet sign    
738                           may use NTLMv2          
739                           must use NTLMv2         
740                           may use Kerberos sec    
741                           must use Kerberos       
742                           may use NTLMSSP         
743                           must use NTLMSSP        
744                           seal (packet encrypt    
745                           must seal               
746                                                   
747 cifsFYI                 If set to non-zero val    
748                         will be logged to the     
749                         contains three flags c    
750                         debugging entries.  Th    
751                         to is 7 which enables     
752                         Some debugging stateme    
753                         cifs kernel unless CON    
754                         kernel configuration.     
755                         more of the following     
756                                                   
757                           +-------------------    
758                           | log cifs informati    
759                           +-------------------    
760                           | log return codes f    
761                           +-------------------    
762                           | log slow responses    
763                           | (ie which take lon    
764                           |                       
765                           | CONFIG_CIFS_STATS2    
766                           +-------------------    
767                                                   
768 traceSMB                If set to one, debug i    
769                         system error log with     
770                         and responses (default    
771 LookupCacheEnable       If set to one, inode i    
772                         for one second improvi    
773                         (default 1)               
774 LinuxExtensionsEnabled  If set to one then the    
775                         use the CIFS "UNIX" ex    
776                         protocol enhancements     
777                         to return accurate UID    
778                         as support symbolic li    
779                         such as Samba that sup    
780                         extensions but do not     
781                         support and want to ma    
782                         to values supplied at     
783                         actual values, then se    
784 dfscache                List the content of th    
785                         If set to 0, the clien    
786 ======================= ======================    
787                                                   
788 These experimental features and tracing can be    
789 /proc/fs/cifs (after the cifs module has been     
790 kernel, e.g.  insmod cifs).  To enable a featu    
791 tracing to the kernel message log type::          
792                                                   
793         echo 7 > /proc/fs/cifs/cifsFYI            
794                                                   
795 cifsFYI functions as a bit mask. Setting it to    
796 logging of various informational messages.  2     
797 SMB return codes while 4 enables logging of re    
798 than one second to complete (except for byte r    
799 Setting it to 4 requires CONFIG_CIFS_STATS2 to    
800 (.config). Setting it to seven enables all thr    
801 the start of smb requests and responses can be    
802                                                   
803         echo 1 > /proc/fs/cifs/traceSMB           
804                                                   
805 Per share (per client mount) statistics are av    
806 Additional information is available if CONFIG_    
807 kernel configuration (.config).  The statistic    
808 represent the number of attempted and failed (    
809 server) SMB3 (or cifs) requests grouped by req    
810 Also recorded is the total bytes read and byte    
811 that share.  Note that due to client caching e    
812 number of bytes read and written by the applic    
813 Statistics can be reset to zero by ``echo 0 >     
814 useful if comparing performance of two differe    
815                                                   
816 Also note that ``cat /proc/fs/cifs/DebugData``    
817 the active sessions and the shares that are mo    
818                                                   
819 Enabling Kerberos (extended security) works bu    
820 of the helper program cifs.upcall to be presen    
821 /etc/request-key.conf file.  The cifs.upcall h    
822 project(https://www.samba.org). NTLM and NTLMv    
823 require this helper. Note that NTLMv2 security    
824 cifs.upcall helper program), instead of using     
825 some use cases.                                   
826                                                   
827 DFS support allows transparent redirection to     
828 In addition, DFS support for target shares whi    
829 names which begin with host names (rather than    
830 a user space helper (such as cifs.upcall) to b    
831 translate host names to ip address, and the us    
832 be configured in the file /etc/request-key.con    
833 many NAS appliances support DFS as a way of co    
834 space to ease network configuration and improv    
835                                                   
836 To use cifs Kerberos and DFS support, the Linu    
837 installed and something like the following lin    
838 /etc/request-key.conf file::                      
839                                                   
840   create cifs.spnego * * /usr/local/sbin/cifs.    
841   create dns_resolver * * /usr/local/sbin/cifs    
842                                                   
843 CIFS kernel module parameters                     
844 =============================                     
845 These module parameters can be specified or mo    
846 module loading or during the runtime by using     
847                                                   
848         /sys/module/cifs/parameters/<param>       
849                                                   
850 i.e.::                                            
851                                                   
852     echo "value" > /sys/module/cifs/parameters    
853                                                   
854 More detailed descriptions of the available mo    
855 can be seen by doing:                             
856                                                   
857     modinfo cifs (or modinfo smb3)                
858                                                   
859 ================= ============================    
860 1. enable_oplocks Enable or disable oplocks. O    
861                   [Y/y/1]. To disable use any     
862 ================= ============================    
                                                      

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

sflogo.php