From 503d1c0226fb38c21b14fe1deac11b0ec461b4d0 Mon Sep 17 00:00:00 2001 From: Holger Hetterich Date: Mon, 29 Sep 2008 14:34:36 +0200 Subject: [PATCH] Add an initial version of a manpage for the vfs_smb_traffic_analyzer module. --- .../manpages-3/vfs_smb_traffic_analyzer.8.xml | 157 ++++++++++++++++++ 1 file changed, 157 insertions(+) create mode 100644 docs-xml/manpages-3/vfs_smb_traffic_analyzer.8.xml diff --git a/docs-xml/manpages-3/vfs_smb_traffic_analyzer.8.xml b/docs-xml/manpages-3/vfs_smb_traffic_analyzer.8.xml new file mode 100644 index 0000000000..c0b1ef89e0 --- /dev/null +++ b/docs-xml/manpages-3/vfs_smb_traffic_analyzer.8.xml @@ -0,0 +1,157 @@ + + + + + + smb_traffic_analyzer + 8 + Samba + System Administration tools + 3.2 + + + + + vfs_smb_traffic_analyzer + log Samba VFS read and write operations through a socket + to a helper application + + + + + vfs objects = smb_traffic_analyzer + + + + + DESCRIPTION + + This VFS module is part of the + samba + 7 suite. + + The vfs_smb_traffic_analyzer VFS module logs + client write and read operations on a Samba server and sends this data + over a socket to a helper program, which feeds a SQL database. More + information on the helper programs can be obtained from the + homepage of the project at: + http://holger123.wordpress.com/smb-traffic-analyzer/ + + vfs_smb_traffic_analyzer currently is aware + of the following VFS operations: + + + write + pwrite + read + pread + + + vfs_smb_traffic_analyzer sends the following data + in a fixed format seperated by a comma through either an internet or a + unix domain socket: + + BYTES|USER|DOMAIN|READ/WRITE|SHARE|FILENAME|TIMESTAMP + + + Description of the records: + + + BYTES - the length in bytes of the VFS operation + USER - the user who initiated the operation + DOMAIN - the domain of the user + READ/WRITE - either "W" for a write operation or "R" for read + SHARE - the name of the share on which the VFS operation occured + FILENAME - the name of the file that was used by the VFS operation + TIMESTAMP - a timestamp, formatted as "yyyy-mm-dd hh-mm-ss.ms" indicating when the VFS operation occured + + + + + This module is stackable. + + + + + + OPTIONS + + + + + smb_traffic_analyzer:mode = STRING + + If STRING matches to "unix_domain_socket", the module will + use a unix domain socket located at /var/tmp/stadsocket, if + STRING contains an different string or is not defined, the module will + use an internet domain socket for data transfer. + + + + + + + smb_traffic_analyzer:host = STRING + + The module will send the data to the system named with + the hostname STRING. + + + + + + smb_traffic_analyzer:port = STRING + + The module will send the data using the TCP port given + in STRING + + + + + + + + + + + EXAMPLES + + The module running on share "example_share", using a unix domain socket + + + /data/example + smb_traffic_analyzer + unix_domain_socket + + + The module running on share "example_share", using an internet domain socket, + connecting to host "examplehost" on port 3491. + + + /data/example + smb_traffic_analyzer + examplehost + 3490 + + + + + + VERSION + This man page is correct for version 3.2.0 of the Samba suite. + + + + + AUTHOR + + The 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. + + The original version of the VFS module and the + helper tools were created by Holger Hetterich. + + + -- 2.34.1