source: vendor/3.6.23/docs/htmldocs/manpages/eventlogadm.8.html

Last change on this file was 860, checked in by Silvan Scherrer, 11 years ago

Samba 3.6: updated vendor to latest version
File size: 7.9 KB
Line 
1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>eventlogadm</title><link rel="stylesheet" href="../samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="eventlogadm"><a name="eventlogadm.8"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>eventlogadm &#8212; push records into the Samba event log store</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="literal">eventlogadm</code> [<code class="option">-s</code>] [<code class="option">-d</code>] [<code class="option">-h</code>] <code class="option">-o</code>
2 <code class="literal">addsource</code>
3 <em class="replaceable"><code>EVENTLOG</code></em>
4 <em class="replaceable"><code>SOURCENAME</code></em>
5 <em class="replaceable"><code>MSGFILE</code></em>
6 </p></div><div class="cmdsynopsis"><p><code class="literal">eventlogadm</code> [<code class="option">-s</code>] [<code class="option">-d</code>] [<code class="option">-h</code>] <code class="option">-o</code>
7 <code class="literal">write</code>
8 <em class="replaceable"><code>EVENTLOG</code></em>
9 </p></div><div class="cmdsynopsis"><p><code class="literal">eventlogadm</code> [<code class="option">-s</code>] [<code class="option">-d</code>] [<code class="option">-h</code>] <code class="option">-o</code>
10 <code class="literal">dump</code>
11 <em class="replaceable"><code>EVENTLOG</code></em>
12 <em class="replaceable"><code>RECORD_NUMBER</code></em>
13 </p></div></div><div class="refsect1" title="DESCRIPTION"><a name="id265759"></a><h2>DESCRIPTION</h2><p>This tool is part of the <a class="citerefentry" href="samba.1.html"><span class="citerefentry"><span class="refentrytitle">samba</span>(1)</span></a> suite.</p><p><code class="literal">eventlogadm</code> is a filter that accepts
14 formatted event log records on standard input and writes them
15 to the Samba event log store. Windows client can then manipulate
16 these record using the usual administration tools.</p></div><div class="refsect1" title="OPTIONS"><a name="id265788"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">
17 <code class="option">-s</code>
18 <em class="replaceable"><code>FILENAME</code></em>
19 </span></dt><dd><p>
20 The <code class="literal">-s</code> option causes <code class="literal">eventlogadm</code> to load the
21 configuration file given as FILENAME instead of the default one used by Samba.
22 </p></dd><dt><span class="term"><code class="option">-d</code></span></dt><dd><p>
23 The <code class="literal">-d</code> option causes <code class="literal">eventlogadm</code> to emit debugging
24 information.
25 </p></dd><dt><span class="term">
26 <code class="option">-o</code>
27 <code class="literal">addsource</code>
28 <em class="replaceable"><code>EVENTLOG</code></em>
29 <em class="replaceable"><code>SOURCENAME</code></em>
30 <em class="replaceable"><code>MSGFILE</code></em>
31 </span></dt><dd><p>
32 The <code class="literal">-o addsource</code> option creates a
33 new event log source.
34 </p></dd><dt><span class="term">
35 <code class="option">-o</code>
36 <code class="literal">write</code>
37 <em class="replaceable"><code>EVENTLOG</code></em>
38 </span></dt><dd><p>
39 The <code class="literal">-o write</code> reads event log
40 records from standard input and writes them to the Samba
41 event log store named by EVENTLOG.
42 </p></dd><dt><span class="term">
43 <code class="option">-o</code>
44 <code class="literal">dump</code>
45 <em class="replaceable"><code>EVENTLOG</code></em>
46 <em class="replaceable"><code>RECORD_NUMBER</code></em>
47 </span></dt><dd><p>
48 The <code class="literal">-o dump</code> reads event log
49 records from a EVENTLOG tdb and dumps them to standard
50 output on screen.
51 </p></dd><dt><span class="term"><code class="option">-h</code></span></dt><dd><p>
52 Print usage information.
53 </p></dd></dl></div></div><div class="refsect1" title="EVENTLOG RECORD FORMAT"><a name="id265966"></a><h2>EVENTLOG RECORD FORMAT</h2><p>For the write operation, <code class="literal">eventlogadm</code>
54 expects to be able to read structured records from standard
55 input. These records are a sequence of lines, with the record key
56 and data separated by a colon character. Records are separated
57 by at least one or more blank line.</p><p>The event log record field are:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
58 <code class="literal">LEN</code> - This field should be 0, since <code class="literal">eventlogadm</code> will calculate this value.
59 </p></li><li class="listitem"><p>
60 <code class="literal">RS1</code> - This must be the value 1699505740.
61 </p></li><li class="listitem"><p>
62 <code class="literal">RCN</code> - This field should be 0.
63 </p></li><li class="listitem"><p>
64 <code class="literal">TMG</code> - The time the eventlog record
65 was generated; format is the number of seconds since
66 00:00:00 January 1, 1970, UTC.
67 </p></li><li class="listitem"><p>
68 <code class="literal">TMW</code> - The time the eventlog record was
69 written; format is the number of seconds since 00:00:00
70 January 1, 1970, UTC.
71 </p></li><li class="listitem"><p>
72 <code class="literal">EID</code> - The eventlog ID.
73 </p></li><li class="listitem"><p>
74 <code class="literal">ETP</code> - The event type -- one of
75 "INFO",
76 "ERROR", "WARNING", "AUDIT
77 SUCCESS" or "AUDIT FAILURE".
78 </p></li><li class="listitem"><p>
79 <code class="literal">ECT</code> - The event category; this depends
80 on the message file. It is primarily used as a means of
81 filtering in the eventlog viewer.
82 </p></li><li class="listitem"><p>
83 <code class="literal">RS2</code> - This field should be 0.
84 </p></li><li class="listitem"><p>
85 <code class="literal">CRN</code> - This field should be 0.
86 </p></li><li class="listitem"><p>
87 <code class="literal">USL</code> - This field should be 0.
88 </p></li><li class="listitem"><p>
89 <code class="literal">SRC</code> - This field contains the source
90 name associated with the event log. If a message file is
91 used with an event log, there will be a registry entry
92 for associating this source name with a message file DLL.
93 </p></li><li class="listitem"><p>
94 <code class="literal">SRN</code> - The name of the machine on
95 which the eventlog was generated. This is typically the
96 host name.
97 </p></li><li class="listitem"><p>
98 <code class="literal">STR</code> - The text associated with the
99 eventlog. There may be more than one string in a record.
100 </p></li><li class="listitem"><p>
101 <code class="literal">DAT</code> - This field should be left unset.
102 </p></li></ul></div></div><div class="refsect1" title="EXAMPLES"><a name="id307202"></a><h2>EXAMPLES</h2><p>An example of the record format accepted by <code class="literal">eventlogadm</code>:</p><pre class="programlisting">
103 LEN: 0
104 RS1: 1699505740
105 RCN: 0
106 TMG: 1128631322
107 TMW: 1128631322
108 EID: 1000
109 ETP: INFO
110 ECT: 0
111 RS2: 0
112 CRN: 0
113 USL: 0
114 SRC: cron
115 SRN: dmlinux
116 STR: (root) CMD ( rm -f /var/spool/cron/lastrun/cron.hourly)
117 DAT:
118 </pre><p>Set up an eventlog source, specifying a message file DLL:</p><pre class="programlisting">
119 eventlogadm -o addsource Application MyApplication | \\
120 %SystemRoot%/system32/MyApplication.dll
121 </pre><p>Filter messages from the system log into an event log:</p><pre class="programlisting">
122 tail -f /var/log/messages | \\
123 my_program_to_parse_into_eventlog_records | \\
124 eventlogadm SystemLogEvents
125 </pre></div><div class="refsect1" title="VERSION"><a name="id307243"></a><h2>VERSION</h2><p>This man page is correct for version 3.0.25 of the Samba suite.</p></div><div class="refsect1" title="AUTHOR"><a name="id307252"></a><h2>AUTHOR</h2><p> The original Samba software and related utilities were
126 created by Andrew Tridgell. Samba is now developed by the
127 Samba Team as an Open Source project similar to the way the
128 Linux kernel is developed.</p></div></div></body></html>
Note: See TracBrowser for help on using the repository browser.