Imported Upstream version 2.4.3
[platform/upstream/audit.git] / docs / zos-remote.conf.5
1 .\" Copyright (c) International Business Machines  Corp., 2007
2 .\"
3 .\" This program is free software;  you can redistribute it and/or
4 .\" modify it under the terms of the GNU General Public License as
5 .\" published by the Free Software Foundation; either version 2 of
6 .\" the License, or (at your option) any later version.
7 .\"
8 .\" This program is distributed in the hope that it will be useful,
9 .\" but WITHOUT ANY WARRANTY;  without even the implied warranty of
10 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
11 .\" the GNU General Public License for more details.
12 .\"
13 .\" You should have received a copy of the GNU General Public License
14 .\" along with this program;  if not, write to the Free Software
15 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston,
16 .\" MA 02111-1307 USA
17 .\"
18 .\" Changelog:
19 .\" 2007-10-06, created by Klaus Heinrich Kiwi <klausk@br.ibm.com>
20 .\"
21 .TH ZOS\-REMOTE.CONF 5 "Oct 2007" "IBM" "System Administration Utilities"
22 .SH NAME
23 zos\-remote.conf \- the audisp-racf plugin configuration file
24 .SH DESCRIPTION
25 .B zos\-remote.conf
26 controls the configuration for the
27 .BR audispd\-zos\-remote (8)
28 Audit dispatcher plugin. The default location for this file is
29 .IR /etc/audisp/zos\-remote.conf ,
30 however, a different file can be specified as the first argument to the
31 .B audispd\-zos\-remote
32 plugin. See
33 .BR audispd\-zos\-remote (8)
34 and
35 .BR auditd (8).
36 The options available are as follows:
37 .TP
38 .I server
39 This is the IBM z/OS ITDS server hostname or IP address
40 .TP
41 .I port
42 The port number where ITDS is running on the z/OS server. Default is 389 (ldap port)
43 .TP
44 .I user
45 The z/OS RACF user ID which the audispd\-zos\-remote plugin will use to perform Remote Audit requests. This user needs READ access to FACILITY Class resource IRR.LDAP.REMOTE.AUDIT (See
46 .BR audispd\-zos\-remote (8)).
47 .TP
48 .I password
49 The password associated the the z/OS user ID configured above.
50 .TP
51 .I timeout
52 The number in seconds that
53 .B audispd\-zos\-remote
54 plugin will wait before giving up in connection attempts and event submissions. The default value is 15
55 .TP
56 .I q_depth
57 The
58 .B audispd\-zos\-remote
59 plugin will queue inputed events to the maximum of
60 .I q_depth
61 events while trying to submit those remotely. This can handle burst of events or in case of a slow network connection. However, the
62 .B audispd\-zos\-remote
63 plugin will drop events in case the queue is full. The default queue depth is 64 - Increase this value in case you are experiencing event drop due to full queue
64 .RB ( audispd\-zos\-remote
65 will log this to syslog).
66 .SH "SEE ALSO"
67 .BR audispd\-zos\-remote (8)
68 .SH AUTHOR
69 Klaus Heinrich Kiwi <klausk@br.ibm.com>