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