Imported Upstream version 2.4.3
[platform/upstream/audit.git] / docs / audispd.conf.5
1 .TH AUDISPD.CONF: "5" "March 2014" "Red Hat" "System Administration Utilities"
2 .SH NAME
3 audispd.conf \- the audit event dispatcher configuration file
4 .SH DESCRIPTION
5 \fBaudispd.conf\fP is the file that controls the configuration of the audit event dispatcher. Each line should contain one configuration keyword, an equal sign, and then followed by appropriate configuration information. All option names and values are case insensitive. The keywords recognized are listed and described below. Each line should be limited to 160 characters or the line will be skipped. You may add comments to the file by starting the line with a '#' character.
6
7 .TP
8 .I q_depth
9 This is a numeric value that tells how big to make the internal queue of the audit event dispatcher. A bigger queue lets it handle a flood of events better, but could hold events that are not processed when the daemon is terminated. If you get messages in syslog about events getting dropped, increase this value. The default value is 80.
10 .TP
11 .I overflow_action
12 This option determines how the daemon should react to overflowing its internal queue. When this happens, it means that more events are being received than it can get rid of. This error means that it is going to lose the current event its trying to dispatch. It has the following choices:
13 .IR ignore ", " syslog ", " suspend ", " single ", and " halt ".
14 If set to
15 .IR ignore ,
16 the audisp daemon does nothing.
17 .I syslog
18 means that it will issue a warning to syslog.
19 .I suspend
20 will cause the audisp daemon to stop processing events. The daemon will still be alive. The
21 .I single
22 option will cause the audisp daemon to put the computer system in single user mode.
23 .I halt
24 option will cause the audisp daemon to shutdown the computer system.
25 .TP
26 .I priority_boost
27 This is a non-negative number that tells the audit event dispatcher how much of a priority boost it should take. This boost is in addition to the boost provided from the audit daemon. The default is 4. No change is 0.
28 .TP
29 .I max_restarts
30 This is a non-negative number that tells the audit event dispatcher how many times it can try to restart a crashed plugin. The default is 10.
31 .TP
32 .I name_format
33 This option controls how computer node names are inserted into the audit event stream. It has the following choices:
34 .IR none ", " hostname ", " fqd ", " numeric ", and " user ".
35 .IR None
36 means that no computer name is inserted into the audit event.
37 .IR hostname
38 is the name returned by the gethostname syscall. The
39 .IR fqd
40 means that it takes the hostname and resolves it with dns for a fully qualified domain name of that machine.
41 .IR Numeric
42 is similar to fqd except it resolves the IP address of the machine.
43 .IR User
44 is an admin defined string from the name option. The default value is
45 .IR none ".
46 .TP
47 .I name
48 This is the admin defined string that identifies the machine if user is given as the name_format option.
49 .SH "SEE ALSO"
50 .BR audispd (8)