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