docs-xml/manpages/vfs_syncops.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="vfs_syncops.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_syncops</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">4.2</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>vfs_syncops</refname>
  16         <refpurpose>Ensure meta data operations are performed synchronously.</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>vfs objects = syncops</command>
  22         </cmdsynopsis>
  23 </refsynopsisdiv>
  24
  25 <refsect1>
  26         <title>DESCRIPTION</title>
  27
  28         <para>This VFS module is part of the
  29         <citerefentry><refentrytitle>samba</refentrytitle>
  30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  31
  32         <para>
  33         Some filesystems (even some journaled filesystems) require that a
  34         fsync() be performed on many meta data operations to ensure that the
  35         operation is guaranteed to remain in the filesystem after a power
  36         failure. This is particularly important for some cluster filesystems
  37         which are participating in a node failover system with clustered
  38         Samba. On those filesystems the <command>vfs_syncops</command> VFS module
  39         provides a way to perform those operations safely.
  40         </para>
  41
  42         <para>This module is stackable.</para>
  43
  44 </refsect1>
  45
  46 <refsect1>
  47         <title>CONFIGURATION</title>
  48
  49         <para>
  50         Most of the performance loss with the <command>vfs_syncops</command>
  51         VFS module is in fsync on close(). You can disable that with
  52         <command>syncops:onclose = no</command> that can be set either globally
  53         or per share.
  54         </para>
  55
  56         <para>
  57         On certain filesystems that only require the last data written to be
  58         fsync()'ed, you can disable the metadata synchronization of this module with
  59         <command>syncops:onmeta = no</command>. This option can be set either
  60         globally or per share.
  61         </para>
  62
  63         <para>
  64         The <command>vfs_syncops</command> VFS module can also be disabled
  65         completely for a share with <command>syncops:disable = true</command>.
  66         </para>
  67 </refsect1>
  68
  69 <refsect1>
  70         <title>EXAMPLES</title>
  71
  72         <para>Add syncops functionality for [share]:</para>
  73 <programlisting>
  74         <smbconfsection name="[share]"/>
  75         <smbconfoption name="path">/data/share</smbconfoption>
  76         <smbconfoption name="vfs objects">syncops</smbconfoption>
  77         <smbconfoption name="syncops:onclose">no</smbconfoption>
  78 </programlisting>
  79
  80 </refsect1>
  81
  82 <refsect1>
  83         <title>VERSION</title>
  84
  85         <para>This man page is correct for version 4.1.0 of the Samba suite.
  86         </para>
  87 </refsect1>
  88
  89 <refsect1>
  90         <title>AUTHOR</title>
  91
  92         <para>The original Samba software and related utilities
  93         were created by Andrew Tridgell. Samba is now developed
  94         by the Samba Team as an Open Source project similar
  95         to the way the Linux kernel is developed.</para>
  96
  97 </refsect1>
  98
  99 </refentry>