GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PANDORAFMS::CORE (3)

.ds Aq ’

NAME

PandoraFMS::Core - Core functions of Pandora FMS

CONTENTS

VERSION

Version 5.0

SYNOPSIS



 use PandoraFMS::Core;



DESCRIPTION

This module contains all the base functions of <B>Pandora FMSB>, the most basic operations of the system are done here.

    Interface Exported Functions:

o pandora_audit
o pandora_create_agent
o pandora_create_group
o pandora_create_incident
o pandora_create_module
o pandora_evaluate_alert
o pandora_evaluate_snmp_alerts
o pandora_event
o pandora_execute_alert
o pandora_execute_action
o pandora_exec_forced_alerts
o pandora_generate_alerts
o pandora_input_password
o pandora_module_keep_alive
o pandora_module_keep_alive_nd
o pandora_output_password
o pandora_planned_downtime
o pandora_process_alert
o pandora_process_module
o pandora_reset_server
o pandora_server_keep_alive
o pandora_update_agent
o pandora_update_agent_address
o pandora_update_module_on_error
o pandora_update_table_from_hash
o pandora_update_server
o pandora_group_statistics
o pandora_server_statistics
o pandora_self_monitoring

METHODS

CWpandora_generate_alerts (CI$pa_configCW CI$dataCW CI$statusCW CI$agentCW CI$moduleCW CI$utimestampCW CI$dbhCW CI$timestampCW CI$extra_macrosCW CI$last_data_valueCW)

Generate alerts for a given $module.

CWpandora_evaluate_alert (CI$pa_configCW, CI$agentCW, CI$dataCW, CI$last_statusCW, CI$alertCW, CI$utimestampCW, CI$dbhCW)

Evaluate trigger conditions for a given alert.

<B>ReturnsB>:
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).

CWpandora_process_alert (CI$pa_configCW, CI$dataCW, CI$agentCW, CI$moduleCW, CI$alertCW, CI$rcCW, CI$dbhCW CI$timestampCW)

Process an alert given the status returned by pandora_evaluate_alert.

CWpandora_execute_alert (CI$pa_configCW, CI$dataCW, CI$agentCW, CI$moduleCW, CI$alertCW, CI$alert_modeCW, CI$dbhCW, CI$timestampCW, CI$forced_alertCW)

Execute the given alert.

CWpandora_execute_action (CI$pa_configCW, CI$dataCW, CI$agentCW, CI$alertCW, CI$alert_modeCW, CI$actionCW, CI$moduleCW, CI$dbhCW, CI$timestampCW)

Execute the given action.

CWpandora_access_update (CI$pa_configCW, CI$agent_idCW, CI$dbhCW)

Update agent access table.

CWpandora_process_module (CI$pa_configCW, CI$dataCW, CI$agentCW, CI$moduleCW, CI$module_typeCW, CI$timestampCW, CI$utimestampCW, CI$server_idCW, CI$dbhCW)

Process Pandora module.

CWpandora_planned_downtime_disabled_once_stop (CI$pa_configCW, CI$dbhCW)

Stop the planned downtime, the once type.

CWpandora_planned_downtime_disabled_once_start (CI$pa_configCW, CI$dbhCW)

Start the planned downtime, the once type.

CWpandora_planned_downtime_set_disabled_elements (CI$pa_configCW, CI$dbhCW, <$id_downtime>)

Start the planned downtime, the once type.

CWpandora_planned_downtime_set_quiet_elements (CI$pa_configCW, CI$dbhCW, <$id_downtime>)

Start the planned downtime, the once type.

CWpandora_planned_downtime_set_quiet_elements (CI$pa_configCW, CI$dbhCW, <$id_downtime>)

Start the planned downtime, the once type.

CWpandora_planned_downtime_unset_quiet_elements (CI$pa_configCW, CI$dbhCW, <$id_downtime>)

Start the planned downtime, the once type.

CWpandora_planned_downtime_quiet_once_stop (CI$pa_configCW, CI$dbhCW)

Start the planned downtime, the once type.

CWpandora_planned_downtime_quiet_once_start (CI$pa_configCW, CI$dbhCW)

Start the planned downtime, the once type.

CWpandora_planned_downtime_monthly_start (CI$pa_configCW, CI$dbhCW)

Start the planned downtime, the monthly type.

CWpandora_planned_downtime_monthly_stop (CI$pa_configCW, CI$dbhCW)

Start the planned downtime, the montly type.

CWpandora_planned_downtime_weekly_start (CI$pa_configCW, CI$dbhCW)

Start the planned downtime, the montly type.

CWpandora_planned_downtime_weekly_stop (CI$pa_configCW, CI$dbhCW)

Stop the planned downtime, the montly type.

CWpandora_planned_downtime (CI$pa_configCW, CI$dbhCW)

Update planned downtimes.

CWpandora_reset_server (CI$pa_configCW, CI$dbhCW)

Reset the status of all server types for the current server.

CWpandora_update_server (CI$pa_configCW, CI$dbhCW, CI$server_nameCW, CI$server_idCW, CI$statusCW, CI$server_typeCW, CI$num_threadsCW, CI$queue_sizeCW)

Update server status:
0 dataserver
1 network server
2 snmp console,
3 recon
4 plugin
5 prediction
6 wmi.

CWpandora_update_agent (CI$pa_configCW, CI$agent_timestampCW, CI$agent_idCW, CI$os_versionCW, CI$agent_versionCW, CI$agent_intervalCW, CI$dbhCW, [CI$timezone_offsetCW], [CI$longitudeCW], [CI$latitudeCW], [CI$altitudeCW], [CI$position_descriptionCW], [CI$parent_agent_nameCW])

Update last contact, timezone fields in <B>tagenteB> and current position (this can affect <B>tgis_data_statusB> and <B>tgis_data_historyB>). If the $parent_agent_id is defined also the parent is updated.

CWpandora_update_gis_data (CI$pa_configCW, CI$dbhCW, CI$agent_idCW, CI$longitudeCW, CI$latitudeCW, CI$altitudeCW)

Update agent GIS information.

CWpandora_create_template_module(CI$pa_configCW, CI$dbhCW, CI$id_agent_moduleCW, CI$id_alert_templateCW, CI$id_policy_alertsCW, CI$disabledCW, CI$standbyCW)

Create a template module.

CWpandora_update_template_module(CI$pa_configCW, CI$dbhCW, CI$id_alertCW, CI$id_policy_alertsCW, CI$disabledCW, CI$standbyCW)

Update a template module.

CWpandora_create_template_module_action(CI$pa_configCW, CI$parametersCW, CI$dbhCW)

Create a template action.

CWpandora_delete_all_template_module_actions(CI$dbhCW, CI$template_module_idCW)

Delete all actions of policy template module.

CWpandora_update_agent_address(CI$pa_configCW, CI$agent_idCW, CI$addressCW, CI$dbhCW)

Update the address of an agent.

CWpandora_module_keep_alive (CI$pa_configCW, CI$id_agentCW, CI$agent_nameCW, CI$server_idCW, CI$dbhCW)

Updates the keep_alive module for the given agent.

CWpandora_create_incident (CI$pa_configCW, CI$dbhCW, CI$titleCW, CI$textCW, CI$priorityCW, CI$statusCW, CI$originCW, CI$id_groupCW)

Create an internal Pandora incident.

CWpandora_audit (CI$pa_configCW, CI$descriptionCW, CI$nameCW, CI$actionCW, CI$dbhCW)

Create an internal audit entry.

CWpandora_create_module (CI$pa_configCW, CI$agent_idCW, CI$module_type_idCW, CI$module_nameCW, CI$maxCW, CI$minCW, CI$post_processCW, CI$descriptionCW, CI$intervalCW, CI$dbhCW)

Create a new entry in tagente_modulo and the corresponding entry in <B>tagente_estadoB>.

CWpandora_create_module_tags (CI$pa_configCW, CI$dbhCW, CI$id_agent_moduleCW, CI$serialized_tagsCW)

Associate tags in a module. The tags are passed separated by commas

CWpandora_create_agent (CI$pa_configCW, CI$server_nameCW, CI$agent_nameCW, CI$addressCW, CI$group_idCW, CI$parent_idCW, CI$os_idCW, CI$descriptionCW, CI$intervalCW, CI$dbhCW, [CI$timezone_offsetCW], [CI$longitudeCW], [CI$latitudeCW], [CI$altitudeCW], [CI$position_descriptionCW], [CI$custom_idCW], [CI$url_addressCW])

Create a new entry in <B>tagenteB> optionaly with position information

CWpandora_event (CI$pa_configCW, CI$eventoCW, CI$id_grupoCW, CI$id_agenteCW, CI$severityCW, CI$id_alert_amCW, CI$id_agentmoduleCW, CI$event_typeCW, CI$event_statusCW, CI$dbhCW)

Generate an event.

CWpandora_update_module_on_error (CI$pa_configCW, CI$id_agent_moduleCW, CI$dbhCW)

Update module status on error.

CWpandora_exec_forced_alerts (CI$pa_configCW, CI$dbhCW)

Execute forced alerts.

CWpandora_module_keep_alive_nd (CI$pa_configCW, CI$dbhCW)

Update keep_alive modules for agents without data.

CWpandora_evaluate_snmp_alerts (CI$pa_configCW, CI$trap_idCW, CI$trap_agentCW, CI$trap_oidCW, CI$trap_oid_textCW, CI$valueCW, CI$trap_custom_oidCW, CI$dbhCW)

Execute alerts that apply to the given SNMP trap.

CWsave_agent_position (CI$pa_configCW, CI$current_longitudeCW, CI$current_latitudeCW, CI$current_altitudeCW, CI$agent_idCW, CI$dbhCW, [CI$start_timestampCW], [CI$descriptionCW])

Saves a new agent GIS information record in <B>tgis_data_statusB> table.

CWupdate_agent_position (CI$pa_configCW, CI$current_longitudeCW, CI$current_latitudeCW, CI$current_altitudeCW, CI$agent_idCW, CI$dbhCW, [CI$stored_longitudeCW], [CI$stored_latitudeCW], [CI$stored_altitudeCW], [CI$start_timestampCW], [CI$descriptionCW])

Updates agent GIS information in <B>tgis_data_statusB> table.

CWarchive_agent_position (CI$pa_configCW, CI$start_timestampCW, CI$end_timestampCW, CI$longitudeCW, CI$latitudeCW, CI$altitudeCW, CI$descriptionCW, CI$number_packagesCW, CI$agent_idCW, CI$dbhCW)

Archives the last position of an agent in the <B>tgis_data_historyB> table

CWpandora_server_statistics (CI$pa_configCW, CI$dbhCW)

Process server statistics for statistics table

CWpandora_process_policy_queue (CI$pa_configCW, CI$dbhCW)

Process groups statistics for statistics table

CWpandora_process_policy_queue (CI$pa_configCW, CI$dbhCW)

Process groups statistics for statistics table

CWpandora_group_statistics (CI$pa_configCW, CI$dbhCW)

Process groups statistics for statistics table

CWpandora_self_monitoring (CI$pa_configCW, CI$dbhCW)

Pandora self monitoring process

CWset_master (CI$pa_configCW, CI$dbhCW)

Set the current master server.

CWis_master (CI$pa_configCW)

Returns 1 if this server is the current master, 0 otherwise.

CWpandora_module_unknown (CI$pa_configCW, CI$dbhCW)

Set the status of unknown modules.

CWget_module_tags (CI$pa_configCW, CI$dbhCW, CI$id_agentmoduleCW)

Get a list of module tags in the format: |tag|tag| ... |tag|

CWget_module_url_tags (CI$pa_configCW, CI$dbhCW, CI$id_agentmoduleCW)

Get a list of module tags in the format: |url|url| ... |url|

CWget_module_email_tags (CI$pa_configCW, CI$dbhCW, CI$id_agentmoduleCW)

Get a list of email module tags in the format: email,email,...,email

CWget_module_phone_tags (CI$pa_configCW, CI$dbhCW, CI$id_agentmoduleCW)

Get a list of phone module tags in the format: phone,phone,...,phone

CWpandora_input_password (CI$pa_configCW, CI$passwordCW)

Process a password to be stored in the Pandora FMS Database (encrypting it if necessary).

CWpandora_output_password (CI$pa_configCW, CI$passwordCW)

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::GIS

LICENSE

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::GIS

COPYRIGHT

Copyright (c) 2005-2011 Artica Soluciones Tecnologicas S.L
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PANDORAFMS::CORE (3) 2016-01-19

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.