tyler.durden
/
pandorafms
mirror of https://github.com/pandorafms/pandorafms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Modified help to describe the real plugins performance. 

Deleted params not used.
pandora_revent and pandora_revent_create are the same except for validate option.
This commit is contained in:
fermin831 2015-10-02 11:23:08 +02:00
parent c4644b4a4b
commit 82b5d07a2f
2 changed files with 133 additions and 151 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
pandora_server/util/pandora_revent.pl
View File

@ -26,24 +26,23 @@ sub help_screen{
print "Options to create event:
\t$0 -p <path_to_consoleAPI> -create event <options>
\t$0 -p <path_to_consoleAPI> -u <credentials> -create_event <options>
Where options:\n
-u <credentials>
-create_event
-u <credentials> : API credentials separated by comma: <api_pass>,<user>,<pass>
-name <event_name> : Free text
-group <id_group> : Group ID (use 0 for 'all')
-agent : Agent ID
-agent : Agent ID
Optional parameters:
[-status <status>] : 0 New, 1 Validated, 2 In process
[-user <id_user>] : User comment (use in combination with -comment option)
[-type <event_type>] : unknown, alert_fired, alert_recovered, alert_ceased
[-type <event_type>] : unknown, alert_fired, alert_recovered, alert_ceased
alert_manual_validation, system, error, new_agent
configuration_change, going_unknown, going_down_critical,
going_down_warning, going_up_normal
[-criticity <criticity>] : 0 Maintance,
[-severity <severity>] : 0 Maintance,
1 Informative,
2 Normal,
3 Warning,
@ -56,23 +55,20 @@ Optional parameters:
[-w_instructions <warning_instructions>]
[-u_instructions <unknown_instructions>]
[-user_comment <comment>]
[-owner_user <user for the event>]
[-owner_user <owner event>] : Use the login name, not the descriptive
[-source <source>] : (By default 'Pandora')
[-tag <tags>] : Tag (must exist in the system to be imported)
[-custom_data <custom_data>]: Custom data should be a base 64 encoded JSON document
[-server_id <server_id>] : The pandora node server_id";
print "Credential/API syntax: \n\n\t";
print "<credentials>: API credentials separated by comma: <api_pass>,<user>,<pass>\n\n";
[-server_id <server_id>] : The pandora node server_id\n\n";
print "Example of event generation:\n\n";
print "\t./pandora_revent.pl -p http://localhost/pandora_console/include/api.php -u 1234,admin,pandora \
\t-create_event -name \"SampleEvent\" -group 2 -agent 189 -status 0 -user \"admin\" -type \"system\" \
\t-criticity 3 -am 0 -alert 9 -c_instructions \"Critical instructions\" -w_instructions \"Warning instructions\" \
\t-severity 3 -am 0 -alert 9 -c_instructions \"Critical instructions\" -w_instructions \"Warning instructions\" \
\t-u_instructions \"Unknown instructions\" -source \"Commandline\" -tag \"Tags\"";
print "\n\nOptions to validate event: \n\n\t";
print "\n\n\nOptions to validate event: \n\n\t";
print "$0 -p <path_to_consoleAPI> -u <credentials> -validate_event <options> -id <id_event>\n\n";
print "Sample of event validation: \n\n\t";
@ -119,17 +115,14 @@ sub tool_api_main () {
my $db_pass;
my @db_info;
my $id_agent;
my $agent_name;
my $id_user = '';
my $status = '';
my $id_agent_module = '';
my $module_name = '';
my $id_alert_am = '';
my $criticity = '';
my $severity = '';
my $user_comment = '';
my $tags = '';
my $source = '';
my $id_extra = '';
my $critical_instructions = '';
my $warning_instructions = '';
my $unknown_instructions = '';
@ -193,9 +186,6 @@ sub tool_api_main () {
if ($line eq '-type') {
$event_type = $ARGV[$i + 1];
}
if ($line eq '-agent_name') {
$agent_name = $ARGV[$i + 1];
}
if ($line eq '-user') {
$id_user = $ARGV[$i + 1];
}
@ -205,14 +195,11 @@ sub tool_api_main () {
if ($line eq '-am') {
$id_agent_module = $ARGV[$i + 1];
}
if ($line eq '-module_name') {
$module_name = $ARGV[$i + 1];
}
if ($line eq '-alert') {
$id_alert_am = $ARGV[$i + 1];
}
if ($line eq '-criticity') {
$criticity = $ARGV[$i + 1];
if ($line eq '-severity') {
$severity = $ARGV[$i + 1];
}
if ($line eq '-tag') {
$tags = $ARGV[$i + 1];
@ -264,7 +251,7 @@ sub tool_api_main () {
"|" . $status .
"|" . $id_user .
"|" . $event_type .
"|" . $criticity .
"|" . $severity .
"|" . $id_agent_module .
"|" . $id_alert_am .
"|" . $critical_instructions .

245
pandora_server/util/pandora_revent_create.pl Normal file → Executable file
View File

@ -12,7 +12,6 @@
# Includes list
use strict;
use LWP::Simple;
use URI::Escape;
# Init
tool_api_init();
@ -23,62 +22,58 @@ tool_api_main();
########################################################################
# Print a help screen and exit.
########################################################################
sub help_screen () {
print "
Options to create event:
sub help_screen{
\t$0 -p <path_to_consoleAPI> -create event <options>
print "Options to create event:
\t$0 -p <path_to_consoleAPI> -u <credentials> -create_event <options>
Where options:\n
-u <credentials>
-create_event
-name <event_name> : Free text
-group <id_group> : Group ID (use 0 for 'all')
-type <event_type> : unknown, alert_fired, alert_recovered, alert_ceased
alert_manual_validation, system, error, new_agent
configuration_change, going_unknown, going_down_critical,
going_down_warning, going_up_normal
-u <credentials> : API credentials separated by comma: <api_pass>,<user>,<pass>
-name <event_name> : Free text
-group <id_group> : Group ID (use 0 for 'all')
-agent : Agent ID
Optional parameters:
[-agent <id_agent>] : Agent ID
[-user <id_user>] : User comment (use in combination with -comment option)
[-status <status>] : 0 New, 1 Validated, 2 In process
[-am <id_agent_module>] : ID Agent Module linked to event
[-alert <id_alert_am>] : ID Alert Module linked to event
[-criticity <criticity>] : 0 Maintance, 1 Informative, 2 Normal,
3 Warning, 4 Crit, 5 Minor, 6 Major
[-comment <user_comment>] : Free text for comment
[-tag <tags>] : Tag (must exist in the system to be imported)
[-source <source>] : (By default 'Pandora')
[-status <status>] : 0 New, 1 Validated, 2 In process
[-user <id_user>] : User comment (use in combination with -comment option)
[-type <event_type>] : unknown, alert_fired, alert_recovered, alert_ceased
alert_manual_validation, system, error, new_agent
configuration_change, going_unknown, going_down_critical,
going_down_warning, going_up_normal
[-severity <severity>] : 0 Maintance,
1 Informative,
2 Normal,
3 Warning,
4 Crit,
5 Minor,
6 Major
[-am <id_agent_module>] : ID Agent Module linked to event
[-alert <id_alert_am>] : ID Alert Module linked to event
[-c_instructions <critical_instructions>]
[-w_instructions <warning_instructions>]
[-u_instructions <unknown_instructions>]
[-owner <owner_user>] : Use the login name, not the descriptive
[-user_comment <comment>]
[-owner_user <owner event>] : Use the login name, not the descriptive
[-source <source>] : (By default 'Pandora')
[-tag <tags>] : Tag (must exist in the system to be imported)
[-custom_data <custom_data>]: Custom data should be a base 64 encoded JSON document
[-server_id <server_id>] : The pandora node server_id\n\n";
print "Example of event generation:\n\n";
Credential/API syntax:
<credentials> : API credentials separated by comma: <api_pass>,<user>,<pass>
print "\t./pandora_revent.pl -p http://localhost/pandora_console/include/api.php -u 1234,admin,pandora \
\t-create_event -name \"SampleEvent\" -group 2 -agent 189 -status 0 -user \"admin\" -type \"system\" \
\t-severity 3 -am 0 -alert 9 -c_instructions \"Critical instructions\" -w_instructions \"Warning instructions\" \
\t-u_instructions \"Unknown instructions\" -source \"Commandline\" -tag \"Tags\"\n\n";
Example of event generation:
$0 -p http://localhost/pandora_console/include/api.php -u 1234,admin,pandora
-create_event -name \"SampleEvent\" -group 2 -type \"system\" -agent 189 -status 0 -user \"admin\"
-criticity 3 -am 0 -alert 9 -c_instructions \"Critical instructions\" -w_instructions \"Warning instructions\"
-u_instructions \"Unknown instructions\" -source \"Commandline\" -tag \"Tags\" -owner \"other\"
";
exit;
}
########################################################################
##############################################################################
# Init screen
########################################################################
##############################################################################
sub tool_api_init () {
print "\nPandora FMS Remote Event Tool Copyright (c) 2013 Artica ST\n";
@ -95,9 +90,6 @@ sub tool_api_init () {
}
########################################################################
########################################################################
# MAIN
@ -117,17 +109,14 @@ sub tool_api_main () {
my $db_pass;
my @db_info;
my $id_agent;
my $agent_name;
my $id_user = '';
my $status = '';
my $id_agent_module = '';
my $module_name = '';
my $id_alert_am = '';
my $criticity = '';
my $severity = '';
my $user_comment = '';
my $tags = '';
my $source = '';
my $id_extra = '';
my $critical_instructions = '';
my $warning_instructions = '';
my $unknown_instructions = '';
@ -135,6 +124,8 @@ sub tool_api_main () {
my $id_event;
my $option = $ARGV[4];
my $call_api;
my $custom_data = "";
my $server_id = 0;
#~ help or api path (required)
if ($ARGV[0] eq '-h') {
@ -170,39 +161,25 @@ sub tool_api_main () {
}
if ($ARGV[4] eq '-create_event') {
#~ event name (required)
if ($ARGV[5] ne '-name') {
print "[ERROR] Missing event name! Read help info:\n\n";
help_screen ();
}
else {
$event_name = uri_escape($ARGV[6]);
}
#~ id group (required)
if ($ARGV[7] ne '-group') {
print "[ERROR] Missing event group! Read help info:\n\n";
help_screen ();
}
else {
$id_group = $ARGV[8];
}
#~ id group (required)
if ($ARGV[9] ne '-type') {
print "[ERROR] Missing event type! Read help info:\n\n";
help_screen ();
}
else {
$event_type = $ARGV[10];
}
my $i = 0;
foreach (@ARGV) {
my $line = $_;
#-----------DEBUG----------------------------
#print("i " . $i . " line " . $line . "\n");
if ($line eq '-agent') {
$id_agent = $ARGV[$i + 1];
}
if ($line eq '-group') {
$id_group = $ARGV[$i + 1];
}
if ($line eq '-name') {
$event_name = $ARGV[$i + 1];
}
if ($line eq '-type') {
$event_type = $ARGV[$i + 1];
}
if ($line eq '-user') {
$id_user = $ARGV[$i + 1];
}
@ -215,89 +192,107 @@ sub tool_api_main () {
if ($line eq '-alert') {
$id_alert_am = $ARGV[$i + 1];
}
if ($line eq '-criticity') {
$criticity = $ARGV[$i + 1];
}
if ($line eq '-comment') {
$user_comment = $ARGV[$i + 1];
if ($line eq '-severity') {
$severity = $ARGV[$i + 1];
}
if ($line eq '-tag') {
$tags = $ARGV[$i+1];
$tags = $ARGV[$i + 1];
}
if ($line eq '-source') {
$source = uri_escape($ARGV[$i + 1]);
$source = $ARGV[$i + 1];
}
if ($line eq '-c_instructions') {
$critical_instructions = uri_escape($ARGV[$i + 1]);
$critical_instructions = $ARGV[$i + 1];
}
if ($line eq '-w_instructions') {
$warning_instructions = uri_escape($ARGV[$i + 1]);
$warning_instructions = $ARGV[$i + 1];
}
if ($line eq '-u_instructions') {
$unknown_instructions = uri_escape($ARGV[$i + 1]);
$unknown_instructions = $ARGV[$i + 1];
}
if ($line eq '-owner') {
$owner_user = $ARGV[$i+1];
if ($line eq '-user_comment') {
$user_comment = $ARGV[$i + 1];
}
if ($line eq '-owner_user') {
$owner_user = $ARGV[$i + 1];
}
if ($line eq '-custom_data') {
$custom_data = $ARGV[$i + 1];
}
if ($line eq '-server_id') {
$server_id = $ARGV[$i + 1];
}
$i++;
}
$data_event = $event_name . "|" .
$id_group . "|" .
$id_agent . "|" .
$status . "|" .
$id_user . "|" .
$event_type . "|" .
$criticity . "|" .
$id_agent_module . "|" .
$id_alert_am . "|" .
$critical_instructions . "|" .
$warning_instructions . "|" .
$unknown_instructions . "|" .
$user_comment . "|" .
$owner_user . "|" .
$source . "|" .
$tags;
if ($event_name eq "") {
print "[ERROR] Missing id agent! Read help info:\n\n";
help_screen ();
}
if ($id_group eq "") {
print "[ERROR] Missing event group! Read help info:\n\n";
help_screen ();
}
if ($id_agent eq "") {
print "[ERROR] Missing id agent! Read help info:\n\n";
help_screen ();
}
$data_event = $event_name .
"|" . $id_group .
"|" . $id_agent .
"|" . $status .
"|" . $id_user .
"|" . $event_type .
"|" . $severity .
"|" . $id_agent_module .
"|" . $id_alert_am .
"|" . $critical_instructions .
"|" . $warning_instructions .
"|" . $unknown_instructions .
"|" . $user_comment .
"|" . $owner_user .
"|" . $source .
"|" . $tags .
"|" . $custom_data .
"|" . $server_id;
$call_api = $api_path . '?' .
'op=set&' .
'op2=create_event&' .
'id=' . $event_name . '&' .
'other=' . $data_event . '&' .
'other=' . $data_event .'&' .
'other_mode=url_encode_separator_|&' .
'apipass=' . $api_pass . '&' .
'user=' . $db_user . '&' .
'pass=' . $db_pass;
#DEBUG TRACE#
#print "$call_api\n";
}
my @args = @ARGV;
my $ltotal = $#args;
my $ltotal=$#args;
if ($ltotal < 0) {
print "[ERROR] No valid arguments. Read help info:\n\n";
help_screen ();
exit;
}
}
else {
my $content = get($call_api);
print("\n\n");
print($call_api);
print("\n\n");
#-----------DEBUG----------------------------
#print($call_api . "\n\n\n");
if ($option eq '-create_event') {
if ($content eq undef) {
print "[ERROR] Not respond or bad syntax. Read help info:\n\n";
help_screen();
}
else {
print "Event ID: $content";
}
}
my $content = get($call_api);
#-----------DEBUG----------------------------
#print($content . "\n\n\n");
if ($content eq undef) {
print "[ERROR] Not respond or bad syntax. Read help info:\n\n";
help_screen();
}
else {
print "Event ID: $content";
}
}
print "\nExiting!\n\n";