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">4.2</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>chmod_acl</member>
  51         <member>fchmod_acl</member>
  52         </simplelist>
  53
  54         <para>This module is stackable.</para>
  55
  56 </refsect1>
  57
  58
  59 <refsect1>
  60         <title>OPTIONS</title>
  61
  62         <variablelist>
  63
  64                 <varlistentry>
  65                 <term>audit:facility = FACILITY</term>
  66                 <listitem>
  67                 <para>Log messages to the named
  68                 <citerefentry><refentrytitle>syslog</refentrytitle>
  69                 <manvolnum>3</manvolnum></citerefentry> facility.
  70
  71                 </para>
  72
  73                 </listitem>
  74                 </varlistentry>
  75
  76                 <varlistentry>
  77                 <term>audit:priority = PRIORITY</term>
  78                 <listitem>
  79                 <para>Log messages with the named
  80                 <citerefentry><refentrytitle>syslog</refentrytitle>
  81                 <manvolnum>3</manvolnum></citerefentry> priority.
  82                 </para>
  83
  84                 </listitem>
  85                 </varlistentry>
  86
  87         </variablelist>
  88 </refsect1>
  89
  90 <refsect1>
  91         <title>EXAMPLES</title>
  92
  93         <para>Log operations on all shares using the LOCAL1 facility
  94         and NOTICE priority:</para>
  95
  96 <programlisting>
  97         <smbconfsection name="[global]"/>
  98         <smbconfoption name="vfs objects">audit</smbconfoption>
  99         <smbconfoption name="audit:facility">LOCAL1</smbconfoption>
 100         <smbconfoption name="audit:priority">NOTICE</smbconfoption>
 101 </programlisting>
 102
 103 </refsect1>
 104
 105 <refsect1>
 106         <title>VERSION</title>
 107
 108         <para>This man page is correct for version 3.0.25 of the Samba suite.
 109         </para>
 110 </refsect1>
 111
 112 <refsect1>
 113         <title>AUTHOR</title>
 114
 115         <para>The original Samba software and related utilities
 116         were created by Andrew Tridgell. Samba is now developed
 117         by the Samba Team as an Open Source project similar
 118         to the way the Linux kernel is developed.</para>
 119
 120 </refsect1>
 121
 122 </refentry>