1bc4146dac9fd96b4187d2009c04b004aea7ed95
[samba.git] / docs-xml / smbdotconf / logging / loglevel.xml
1 <samba:parameter name="log level"
2                  type="string"
3                  context="G"
4                  handler="handle_debug_list"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <synonym>debuglevel</synonym>
7 <description>
8     <para>
9     The value of the parameter (a astring) allows the debug level (logging level) to be specified in the 
10     <filename moreinfo="none">smb.conf</filename> file. 
11     </para>
12
13     <para>This parameter has been extended since the 2.2.x 
14     series, now it allows one to specify the debug level for multiple 
15     debug classes and distinct logfiles for debug classes. This is to give
16     greater flexibility in the configuration of the system. The following
17     debug classes are currently implemented:
18     </para>
19
20     <itemizedlist>
21         <listitem><para><parameter moreinfo="none">all</parameter></para></listitem>
22         <listitem><para><parameter moreinfo="none">tdb</parameter></para></listitem>
23         <listitem><para><parameter moreinfo="none">printdrivers</parameter></para></listitem>
24         <listitem><para><parameter moreinfo="none">lanman</parameter></para></listitem>
25         <listitem><para><parameter moreinfo="none">smb</parameter></para></listitem>
26         <listitem><para><parameter moreinfo="none">smb2</parameter></para></listitem>
27         <listitem><para><parameter moreinfo="none">smb2_credits</parameter></para></listitem>
28         <listitem><para><parameter moreinfo="none">rpc_parse</parameter></para></listitem>
29         <listitem><para><parameter moreinfo="none">rpc_srv</parameter></para></listitem>
30         <listitem><para><parameter moreinfo="none">rpc_cli</parameter></para></listitem>
31         <listitem><para><parameter moreinfo="none">passdb</parameter></para></listitem>
32         <listitem><para><parameter moreinfo="none">sam</parameter></para></listitem>
33         <listitem><para><parameter moreinfo="none">auth</parameter></para></listitem>
34         <listitem><para><parameter moreinfo="none">winbind</parameter></para></listitem>
35         <listitem><para><parameter moreinfo="none">vfs</parameter></para></listitem>
36         <listitem><para><parameter moreinfo="none">idmap</parameter></para></listitem>
37         <listitem><para><parameter moreinfo="none">quota</parameter></para></listitem>
38         <listitem><para><parameter moreinfo="none">acls</parameter></para></listitem>
39         <listitem><para><parameter moreinfo="none">locking</parameter></para></listitem>
40         <listitem><para><parameter moreinfo="none">msdfs</parameter></para></listitem>
41         <listitem><para><parameter moreinfo="none">dmapi</parameter></para></listitem>
42         <listitem><para><parameter moreinfo="none">registry</parameter></para></listitem>
43         <listitem><para><parameter moreinfo="none">scavenger</parameter></para></listitem>
44         <listitem><para><parameter moreinfo="none">dns</parameter></para></listitem>
45         <listitem><para><parameter moreinfo="none">ldb</parameter></para></listitem>
46         <listitem><para><parameter moreinfo="none">tevent</parameter></para></listitem>
47         <listitem><para><parameter moreinfo="none">auth_audit</parameter></para></listitem>
48         <listitem><para><parameter moreinfo="none">auth_json_audit</parameter></para></listitem>
49         <listitem><para><parameter moreinfo="none">kerberos</parameter></para></listitem>
50         <listitem><para><parameter moreinfo="none">dsdb_audit</parameter></para></listitem>
51         <listitem><para><parameter moreinfo="none">dsdb_json_audit</parameter></para></listitem>
52         <listitem><para><parameter moreinfo="none">dsdb_password_audit</parameter></para></listitem>
53         <listitem><para><parameter moreinfo="none">dsdb_password_json_audit</parameter></para></listitem>
54         <listitem><para><parameter moreinfo="none">dsdb_transaction_audit</parameter></para></listitem>
55         <listitem><para><parameter moreinfo="none">dsdb_transaction_json_audit</parameter></para></listitem>
56     </itemizedlist>
57
58     <para>To configure the logging for specific classes to go into a different
59     file then <smbconfoption name="log file"/>, you can append
60     <emphasis>@PATH</emphasis> to the class, eg <parameter>log level = 1
61     full_audit:1@/var/log/audit.log</parameter>.</para>
62
63     <para>Authentication and authorization audit information is logged
64     under the auth_audit, and if Samba was not compiled with
65     --without-json, a JSON representation is logged under
66     auth_json_audit.</para>
67
68     <para>Support is comprehensive for all authentication and authorisation
69     of user accounts in the Samba Active Directory Domain Controller,
70     as well as the implicit authentication in password changes.  In
71     the file server, NTLM authentication, SMB and RPC authorization is
72     covered.</para>
73
74     <para>Log levels for auth_audit and auth_audit_json are:</para>
75     <itemizedlist>
76         <listitem><para>2: Authentication Failure</para></listitem>
77         <listitem><para>3: Authentication Success</para></listitem>
78         <listitem><para>4: Authorization Success</para></listitem>
79         <listitem><para>5: Anonymous Authentication and Authorization Success</para></listitem>
80     </itemizedlist>
81
82     <para>Changes to the sam.ldb database are logged
83     under the dsdb_audit and a JSON representation is logged under
84     dsdb_json_audit.</para>
85
86     <para>Password changes and Password resets are logged under
87     dsdb_password_audit and a JSON representation is logged under the
88     dsdb_password_json_audit.</para>
89
90     <para>Transaction rollbacks and prepare commit failures are logged under
91     the dsdb_transaction_audit and a JSON representation is logged under the
92     password_json_audit. Logging the transaction details allows the
93     identification of password and sam.ldb operations that have been rolled
94     back.</para>
95
96
97 </description>
98 <value type="default">0</value>
99 <value type="example">3 passdb:5 auth:10 winbind:2</value>
100 <value type="example">1 full_audit:1@/var/log/audit.log winbind:2</value>
101 </samba:parameter>