source: branches/samba-3.2.x/docs/manpages/vfs_full_audit.8@ 200

Last change on this file since 200 was 149, checked in by Paul Smedley, 17 years ago

Update trunk to v3.2.2

File size: 5.1 KB
Line 
1.\" Title: vfs_full_audit
2.\" Author:
3.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
4.\" Date: 08/18/2008
5.\" Manual: System Administration tools
6.\" Source: Samba 3.2
7.\"
8.TH "VFS_FULL_AUDIT" "8" "08/18/2008" "Samba 3\.2" "System Administration tools"
9.\" disable hyphenation
10.nh
11.\" disable justification (adjust text to left margin only)
12.ad l
13.SH "NAME"
14vfs_full_audit - record Samba VFS operations in the system log
15.SH "SYNOPSIS"
16.HP 1
17vfs objects = full_audit
18.SH "DESCRIPTION"
19.PP
20This VFS module is part of the
21\fBsamba\fR(7)
22suite\.
23.PP
24The
25vfs_full_audit
26VFS module records selected client operations to the system log using
27\fBsyslog\fR(3)\.
28.PP
29vfs_full_audit
30is able to record the complete set of Samba VFS operations:
31.IP "" 4
32aio_cancel
33.IP "" 4
34aio_error
35.IP "" 4
36aio_fsync
37.IP "" 4
38aio_read
39.IP "" 4
40aio_return
41.IP "" 4
42aio_suspend
43.IP "" 4
44aio_write
45.IP "" 4
46chdir
47.IP "" 4
48chflags
49.IP "" 4
50chmod
51.IP "" 4
52chmod_acl
53.IP "" 4
54chown
55.IP "" 4
56close
57.IP "" 4
58closedir
59.IP "" 4
60connect
61.IP "" 4
62disconnect
63.IP "" 4
64disk_free
65.IP "" 4
66fchmod
67.IP "" 4
68fchmod_acl
69.IP "" 4
70fchown
71.IP "" 4
72fget_nt_acl
73.IP "" 4
74fgetxattr
75.IP "" 4
76flistxattr
77.IP "" 4
78fremovexattr
79.IP "" 4
80fset_nt_acl
81.IP "" 4
82fsetxattr
83.IP "" 4
84fstat
85.IP "" 4
86fsync
87.IP "" 4
88ftruncate
89.IP "" 4
90get_nt_acl
91.IP "" 4
92get_quota
93.IP "" 4
94get_shadow_copy_data
95.IP "" 4
96getlock
97.IP "" 4
98getwd
99.IP "" 4
100getxattr
101.IP "" 4
102kernel_flock
103.IP "" 4
104lgetxattr
105.IP "" 4
106link
107.IP "" 4
108linux_setlease
109.IP "" 4
110listxattr
111.IP "" 4
112llistxattr
113.IP "" 4
114lock
115.IP "" 4
116lremovexattr
117.IP "" 4
118lseek
119.IP "" 4
120lsetxattr
121.IP "" 4
122lstat
123.IP "" 4
124mkdir
125.IP "" 4
126mknod
127.IP "" 4
128open
129.IP "" 4
130opendir
131.IP "" 4
132pread
133.IP "" 4
134pwrite
135.IP "" 4
136read
137.IP "" 4
138readdir
139.IP "" 4
140readlink
141.IP "" 4
142realpath
143.IP "" 4
144removexattr
145.IP "" 4
146rename
147.IP "" 4
148rewinddir
149.IP "" 4
150rmdir
151.IP "" 4
152seekdir
153.IP "" 4
154sendfile
155.IP "" 4
156set_nt_acl
157.IP "" 4
158set_quota
159.IP "" 4
160setxattr
161.IP "" 4
162stat
163.IP "" 4
164statvfs
165.IP "" 4
166symlink
167.IP "" 4
168sys_acl_add_perm
169.IP "" 4
170sys_acl_clear_perms
171.IP "" 4
172sys_acl_create_entry
173.IP "" 4
174sys_acl_delete_def_file
175.IP "" 4
176sys_acl_free_acl
177.IP "" 4
178sys_acl_free_qualifier
179.IP "" 4
180sys_acl_free_text
181.IP "" 4
182sys_acl_get_entry
183.IP "" 4
184sys_acl_get_fd
185.IP "" 4
186sys_acl_get_file
187.IP "" 4
188sys_acl_get_perm
189.IP "" 4
190sys_acl_get_permset
191.IP "" 4
192sys_acl_get_qualifier
193.IP "" 4
194sys_acl_get_tag_type
195.IP "" 4
196sys_acl_init
197.IP "" 4
198sys_acl_set_fd
199.IP "" 4
200sys_acl_set_file
201.IP "" 4
202sys_acl_set_permset
203.IP "" 4
204sys_acl_set_qualifier
205.IP "" 4
206sys_acl_set_tag_type
207.IP "" 4
208sys_acl_to_text
209.IP "" 4
210sys_acl_valid
211.IP "" 4
212telldir
213.IP "" 4
214unlink
215.IP "" 4
216utime
217.IP "" 4
218write
219.PP
220In addition to these operations,
221vfs_full_audit
222recognizes the special operation names "all" and "none ", which refer to all the VFS operations and none of the VFS operations respectively\.
223.PP
224vfs_full_audit
225records operations in fixed format consisting of fields separated by \'|\' characters\. The format is:
226.sp
227.RS 4
228.nf
229 smbd_audit: PREFIX|OPERATION|RESULT|FILE
230
231.fi
232.RE
233.PP
234The record fields are:
235.sp
236.RS 4
237.ie n \{\
238\h'-04'\(bu\h'+03'\c
239.\}
240.el \{\
241.sp -1
242.IP \(bu 2.3
243.\}
244PREFIX
245\- the result of the full_audit:prefix string after variable substitutions
246.RE
247.sp
248.RS 4
249.ie n \{\
250\h'-04'\(bu\h'+03'\c
251.\}
252.el \{\
253.sp -1
254.IP \(bu 2.3
255.\}
256OPERATION
257\- the name of the VFS operation
258.RE
259.sp
260.RS 4
261.ie n \{\
262\h'-04'\(bu\h'+03'\c
263.\}
264.el \{\
265.sp -1
266.IP \(bu 2.3
267.\}
268RESULT
269\- whether the operation succeeded or failed
270.RE
271.sp
272.RS 4
273.ie n \{\
274\h'-04'\(bu\h'+03'\c
275.\}
276.el \{\
277.sp -1
278.IP \(bu 2.3
279.\}
280FILE
281\- the name of the file or directory the operation was performed on
282.sp
283.RE
284.PP
285This module is stackable\.
286.SH "OPTIONS"
287.PP
288vfs_full_audit:prefix = STRING
289.RS 4
290Prepend audit messages with STRING\. STRING is processed for standard substitution variables listed in
291\fBsmb.conf\fR(5)\. The default prefix is "%u|%I"\.
292.RE
293.PP
294vfs_full_audit:success = LIST
295.RS 4
296LIST is a list of VFS operations that should be recorded if they succeed\. Operations are specified using the names listed above\.
297.RE
298.PP
299vfs_full_audit:failure = LIST
300.RS 4
301LIST is a list of VFS operations that should be recorded if they failed\. Operations are specified using the names listed above\.
302.RE
303.PP
304full_audit:facility = FACILITY
305.RS 4
306Log messages to the named
307\fBsyslog\fR(3)
308facility\.
309.RE
310.PP
311full_audit:priority = PRIORITY
312.RS 4
313Log messages with the named
314\fBsyslog\fR(3)
315priority\.
316.RE
317.SH "EXAMPLES"
318.PP
319Log file and directory open operations on the [records] share using the LOCAL7 facility and ALERT priority, including the username and IP address:
320.sp
321.RS 4
322.nf
323 \fI[records]\fR
324 \fIpath = /data/records\fR
325 \fIvfs objects = full_audit\fR
326 \fIfull_audit:prefix = %u|%I\fR
327 \fIfull_audit:success = open opendir\fR
328 \fIfull_audit:failure = all\fR
329 \fIfull_audit:facility = LOCAL7\fR
330 \fIfull_audit:priority = ALERT\fR
331.fi
332.RE
333.SH "VERSION"
334.PP
335This man page is correct for version 3\.0\.25 of the Samba suite\.
336.SH "AUTHOR"
337.PP
338The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\.
Note: See TracBrowser for help on using the repository browser.