docs-xml/manpages/vfs_audit.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_audit.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_audit</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>vfs_audit</refname>
  16         <refpurpose>record selected Samba VFS operations in the system log</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>vfs objects = audit</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>The <command>vfs_audit</command> VFS module records selected
  33         client operations to the system log using
  34         <citerefentry><refentrytitle>syslog</refentrytitle>
  35         <manvolnum>3</manvolnum></citerefentry>.</para>
  36
  37         <para>The following Samba VFS operations are recorded:</para>
  38         <simplelist>
  39         <member>connect</member>
  40         <member>disconnect</member>
  41         <member>opendir</member>
  42         <member>mkdir</member>
  43         <member>rmdir</member>
  44         <member>open</member>
  45         <member>close</member>
  46         <member>rename</member>
  47         <member>unlink</member>
  48         <member>chmod</member>
  49         <member>fchmod</member>
  50         <member>fchmod_acl</member>
  51         </simplelist>
  52
  53         <para>This module is stackable.</para>
  54
  55 </refsect1>
  56
  57
  58 <refsect1>
  59         <title>OPTIONS</title>
  60
  61         <variablelist>
  62
  63                 <varlistentry>
  64                 <term>audit:facility = FACILITY</term>
  65                 <listitem>
  66                 <para>Log messages to the named
  67                 <citerefentry><refentrytitle>syslog</refentrytitle>
  68                 <manvolnum>3</manvolnum></citerefentry> facility.
  69
  70                 </para>
  71
  72                 </listitem>
  73                 </varlistentry>
  74
  75                 <varlistentry>
  76                 <term>audit:priority = PRIORITY</term>
  77                 <listitem>
  78                 <para>Log messages with the named
  79                 <citerefentry><refentrytitle>syslog</refentrytitle>
  80                 <manvolnum>3</manvolnum></citerefentry> priority.
  81                 </para>
  82
  83                 </listitem>
  84                 </varlistentry>
  85
  86         </variablelist>
  87 </refsect1>
  88
  89 <refsect1>
  90         <title>EXAMPLES</title>
  91
  92         <para>Log operations on all shares using the LOCAL1 facility
  93         and NOTICE priority:</para>
  94
  95 <programlisting>
  96         <smbconfsection name="[global]"/>
  97         <smbconfoption name="vfs objects">audit</smbconfoption>
  98         <smbconfoption name="audit:facility">LOCAL1</smbconfoption>
  99         <smbconfoption name="audit:priority">NOTICE</smbconfoption>
 100 </programlisting>
 101
 102 </refsect1>
 103
 104 <refsect1>
 105         <title>VERSION</title>
 106
 107         <para>This man page is part of version &doc.version; of the Samba suite.
 108         </para>
 109 </refsect1>
 110
 111 <refsect1>
 112         <title>AUTHOR</title>
 113
 114         <para>The original Samba software and related utilities
 115         were created by Andrew Tridgell. Samba is now developed
 116         by the Samba Team as an Open Source project similar
 117         to the way the Linux kernel is developed.</para>
 118
 119 </refsect1>
 120
 121 </refentry>