new upstream release (3.3.0); modify package compatibility for Stretch
[ossec-hids.git] / debian / ossec-hids / usr / share / doc / ossec-hids / contrib / ossec_report.txt
1 OSSEC report tool 0.1
2 Licensed under GPL
3 Contributor Meir Michanie
4 ossec_report_contrib.pl [-h|--help] # This text you read now
5 ossec_report_contrib.pl [-r|--report] # prints a report for each element
6 ossec_report_contrib.pl [-s|--summary] # prints a summary report
7 ossec_report_contrib.pl [-t|--top] #prints the top list
8
9 How To:
10 =======
11
12 ossec_report_contrib.pl OSSEC report tool 0.1
13 ossec_report_contrib.pl is a GNU style program.
14 It reads from STDIN and write to stdout. This gives you the advantage to use it in pipes.
15 i.e.
16 cat ossec-alerts-05.log | ossec_report_contrib.pl -r | mail root -s 'OSSEC detailed report'
17 cat ossec-alerts-05.log | ossec_report_contrib.pl -s | mail root -s 'OSSEC summary report'
18 cat <log file> | ossec_report_contrib.pl -t <key> | head -n 15 (for top 15)
19 cat <log file> | ossec_report_contrib.pl -s (for summary)
20
21 Crontab entry:
22 58 23 * * * (cat ossec-alerts-05.log | ossec_report_contrib.pl -s)
23      
24
25 The <key> could be any one of the variables used in ossec log:
26 mail,alerthost,datasource,rule,level,description,srcip,user.