|
Unix VPS
Support
FAQ
Network
Miscellaneous
|
| PandoraFMS::Core(3) | User Contributed Perl Documentation | PandoraFMS::Core(3) |
NAME
PandoraFMS::Core - Core functions of Pandora FMSVERSION
Version 5.0SYNOPSIS
use PandoraFMS::Core;
DESCRIPTION
This module contains all the base functions of Pandora FMS, the most basic operations of the system are done here.Interface Exported Functions:
- "pandora_audit"
- "pandora_create_agent"
- "pandora_create_group"
- "pandora_create_incident"
- "pandora_create_module"
- "pandora_evaluate_alert"
- "pandora_evaluate_snmp_alerts"
- "pandora_event"
- "pandora_execute_alert"
- "pandora_execute_action"
- "pandora_exec_forced_alerts"
- "pandora_generate_alerts"
- "pandora_input_password"
- "pandora_module_keep_alive"
- "pandora_module_keep_alive_nd"
- "pandora_output_password"
- "pandora_planned_downtime"
- "pandora_process_alert"
- "pandora_process_module"
- "pandora_reset_server"
- "pandora_server_keep_alive"
- "pandora_update_agent"
- "pandora_update_agent_address"
- "pandora_update_module_on_error"
- "pandora_update_table_from_hash"
- "pandora_update_server"
- "pandora_group_statistics"
- "pandora_server_statistics"
- "pandora_self_monitoring"
METHODS
"pandora_generate_alerts ($pa_config $data $status $agent $module $utimestamp $dbh $timestamp $extra_macros $last_data_value)"
Generate alerts for a given $module."pandora_evaluate_alert ($pa_config, $agent, $data, $last_status, $alert, $utimestamp, $dbh)"
Evaluate trigger conditions for a given alert.Returns: 0 Execute the alert. 1 Do not execute the alert. 2 Do not execute the alert, but increment its internal counter. 3 Cease the alert. 4 Recover the alert. 5 Reset internal counter (alert not fired, interval elapsed).
"pandora_process_alert ($pa_config, $data, $agent, $module, $alert, $rc, $dbh $timestamp)"
Process an alert given the status returned by pandora_evaluate_alert."pandora_execute_alert ($pa_config, $data, $agent, $module, $alert, $alert_mode, $dbh, $timestamp, $forced_alert)"
Execute the given alert."pandora_execute_action ($pa_config, $data, $agent, $alert, $alert_mode, $action, $module, $dbh, $timestamp)"
Execute the given action."pandora_access_update ($pa_config, $agent_id, $dbh)"
Update agent access table."pandora_process_module ($pa_config, $data, $agent, $module, $module_type, $timestamp, $utimestamp, $server_id, $dbh)"
Process Pandora module."pandora_planned_downtime_disabled_once_stop ($pa_config, $dbh)"
Stop the planned downtime, the once type."pandora_planned_downtime_disabled_once_start ($pa_config, $dbh)"
Start the planned downtime, the once type."pandora_planned_downtime_set_disabled_elements ($pa_config, $dbh, <$id_downtime>)"
Start the planned downtime, the once type."pandora_planned_downtime_set_quiet_elements ($pa_config, $dbh, <$id_downtime>)"
Start the planned downtime, the once type."pandora_planned_downtime_set_quiet_elements ($pa_config, $dbh, <$id_downtime>)"
Start the planned downtime, the once type."pandora_planned_downtime_unset_quiet_elements ($pa_config, $dbh, <$id_downtime>)"
Start the planned downtime, the once type."pandora_planned_downtime_quiet_once_stop ($pa_config, $dbh)"
Start the planned downtime, the once type."pandora_planned_downtime_quiet_once_start ($pa_config, $dbh)"
Start the planned downtime, the once type."pandora_planned_downtime_monthly_start ($pa_config, $dbh)"
Start the planned downtime, the monthly type."pandora_planned_downtime_monthly_stop ($pa_config, $dbh)"
Start the planned downtime, the montly type."pandora_planned_downtime_weekly_start ($pa_config, $dbh)"
Start the planned downtime, the montly type."pandora_planned_downtime_weekly_stop ($pa_config, $dbh)"
Stop the planned downtime, the montly type."pandora_planned_downtime ($pa_config, $dbh)"
Update planned downtimes."pandora_reset_server ($pa_config, $dbh)"
Reset the status of all server types for the current server."pandora_update_server ($pa_config, $dbh, $server_name, $server_id, $status, $server_type, $num_threads, $queue_size)"
Update server status: 0 dataserver 1 network server 2 snmp console, 3 recon 4 plugin 5 prediction 6 wmi."pandora_update_agent ($pa_config, $agent_timestamp, $agent_id, $os_version, $agent_version, $agent_interval, $dbh, [$timezone_offset], [$longitude], [$latitude], [$altitude], [$position_description], [$parent_agent_name])"
Update last contact, timezone fields in tagente and current position (this can affect tgis_data_status and tgis_data_history). If the $parent_agent_id is defined also the parent is updated."pandora_update_gis_data ($pa_config, $dbh, $agent_id, $longitude, $latitude, $altitude)"
Update agent GIS information."pandora_create_template_module($pa_config, $dbh, $id_agent_module, $id_alert_template, $id_policy_alerts, $disabled, $standby)"
Create a template module."pandora_update_template_module($pa_config, $dbh, $id_alert, $id_policy_alerts, $disabled, $standby)"
Update a template module."pandora_create_template_module_action($pa_config, $parameters, $dbh)"
Create a template action."pandora_delete_all_template_module_actions($dbh, $template_module_id)"
Delete all actions of policy template module."pandora_update_agent_address($pa_config, $agent_id, $address, $dbh)"
Update the address of an agent."pandora_module_keep_alive ($pa_config, $id_agent, $agent_name, $server_id, $dbh)"
Updates the keep_alive module for the given agent."pandora_create_incident ($pa_config, $dbh, $title, $text, $priority, $status, $origin, $id_group)"
Create an internal Pandora incident."pandora_audit ($pa_config, $description, $name, $action, $dbh)"
Create an internal audit entry."pandora_create_module ($pa_config, $agent_id, $module_type_id, $module_name, $max, $min, $post_process, $description, $interval, $dbh)"
Create a new entry in tagente_modulo and the corresponding entry in tagente_estado."pandora_create_module_tags ($pa_config, $dbh, $id_agent_module, $serialized_tags)"
Associate tags in a module. The tags are passed separated by commas"pandora_create_agent ($pa_config, $server_name, $agent_name, $address, $group_id, $parent_id, $os_id, $description, $interval, $dbh, [$timezone_offset], [$longitude], [$latitude], [$altitude], [$position_description], [$custom_id], [$url_address])"
Create a new entry in tagente optionaly with position information"pandora_event ($pa_config, $evento, $id_grupo, $id_agente, $severity, $id_alert_am, $id_agentmodule, $event_type, $event_status, $dbh)"
Generate an event."pandora_update_module_on_error ($pa_config, $id_agent_module, $dbh)"
Update module status on error."pandora_exec_forced_alerts ($pa_config, $dbh)"
Execute forced alerts."pandora_module_keep_alive_nd ($pa_config, $dbh)"
Update keep_alive modules for agents without data."pandora_evaluate_snmp_alerts ($pa_config, $trap_id, $trap_agent, $trap_oid, $trap_oid_text, $value, $trap_custom_oid, $dbh)"
Execute alerts that apply to the given SNMP trap."save_agent_position ($pa_config, $current_longitude, $current_latitude, $current_altitude, $agent_id, $dbh, [$start_timestamp], [$description])"
Saves a new agent GIS information record in tgis_data_status table."update_agent_position ($pa_config, $current_longitude, $current_latitude, $current_altitude, $agent_id, $dbh, [$stored_longitude], [$stored_latitude], [$stored_altitude], [$start_timestamp], [$description])"
Updates agent GIS information in tgis_data_status table."archive_agent_position ($pa_config, $start_timestamp, $end_timestamp, $longitude, $latitude, $altitude, $description, $number_packages, $agent_id, $dbh)"
Archives the last position of an agent in the tgis_data_history table"pandora_server_statistics ($pa_config, $dbh)"
Process server statistics for statistics table"pandora_process_policy_queue ($pa_config, $dbh)"
Process groups statistics for statistics table"pandora_process_policy_queue ($pa_config, $dbh)"
Process groups statistics for statistics table"pandora_group_statistics ($pa_config, $dbh)"
Process groups statistics for statistics table"pandora_self_monitoring ($pa_config, $dbh)"
Pandora self monitoring process"set_master ($pa_config, $dbh)"
Set the current master server."is_master ($pa_config)"
Returns 1 if this server is the current master, 0 otherwise."pandora_module_unknown ($pa_config, $dbh)"
Set the status of unknown modules."get_module_tags ($pa_config, $dbh, $id_agentmodule)"
Get a list of module tags in the format: |tag|tag| ... |tag|"get_module_url_tags ($pa_config, $dbh, $id_agentmodule)"
Get a list of module tags in the format: |url|url| ... |url|"get_module_email_tags ($pa_config, $dbh, $id_agentmodule)"
Get a list of email module tags in the format: email,email,...,email"get_module_phone_tags ($pa_config, $dbh, $id_agentmodule)"
Get a list of phone module tags in the format: phone,phone,...,phone"pandora_input_password ($pa_config, $password)"
Process a password to be stored in the Pandora FMS Database (encrypting it if necessary)."pandora_output_password ($pa_config, $password)"
Process a password retrieved from the Pandora FMS Database (decrypting it if necessary).DEPENDENCIES
DBI, XML::Simple, HTML::Entities, Time::Local, POSIX, PandoraFMS::DB, PandoraFMS::Config, PandoraFMS::Tools, PandoraFMS::GISLICENSE
This is released under the GNU Lesser General Public License.SEE ALSO
DBI, XML::Simple, HTML::Entities, Time::Local, POSIX, PandoraFMS::DB, PandoraFMS::Config, PandoraFMS::Tools, PandoraFMS::GISCOPYRIGHT
Copyright (c) 2005-2011 Artica Soluciones Tecnologicas S.L| 2016-04-08 | perl v5.32.1 |
Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.