diff --git a/pandora_console/ChangeLog b/pandora_console/ChangeLog index 90e1193574..d78d56773c 100644 --- a/pandora_console/ChangeLog +++ b/pandora_console/ChangeLog @@ -1,3 +1,73 @@ +2009-08-24 Miguel de Dios + + * include/functions_menu.php, include/functions_html.php, + include/functions_events.php, include/functions_messages.php, + include/functions_modules.php, include/functions_exportserver.php, + include/functions_reporting.php, include/functions_filemanager.php, + include/pchart_graph.php, include/pandora_graph.php, include/auth/dev.php, + include/auth/ldap.php, include/auth/mysql.php, include/config.inc.php, + include/functions_networkmap.php, include/functions_servers.php, + include/FusionCharts/FusionCharts_Gen.php, + include/FusionCharts/FusionCharts.php, + include/functions_network_profiles.php, include/gettext.php, + include/functions_network_components.php, include/functions_visual_map.php, + include/fgraph2.php, include/Image/image_functions.php, + include/functions_config.php, include/help/en/help_plugin_parameters.php, + include/help/en/help_snmpcommunity.php, include/help/en/help_wmiquery.php, + include/help/en/help_postprocess.php, + include/help/en/help_prediction_source_module.php, + include/help/en/help_date_format.php, include/help/en/help_recontask.php, + include/help/en/help_alert-matches.php, include/help/en/help_tcp_send.php, + include/help/en/help_wmifield.php, include/help/en/help_duplicateconfig.php, + include/help/en/help_agent_status.php, + include/help/en/help_manage_alerts.php, include/help/en/help_wmikey.php, + include/help/en/help_alert_type.php, + include/help/en/help_network_component.php, + include/help/en/help_time_stamp-comparation.php, + include/help/en/help_eventview.php, include/help/en/help_timesource.php, + include/help/en/help_alert_validation.php, + include/help/en/help_map_builder.php, + include/help/en/help_alert_recovery.php, + include/help/en/help_module_type.php, + include/help/en/help_planned_downtime.php, + include/help/en/help_serverlag.php, include/help/en/help_alerts.php, + include/help/en/help_snmpwalk.php, + include/help/en/help_module_definition.php, + include/help/en/help_plugin_definition.php, + include/help/en/help_wminamespace.php, include/help/en/help_snmpoid.php + include/help/en/help_manageconfig.php, + include/help/es/help_alert_validation.php, + include/help/es/help_plugin_parameters.php, + include/help/es/help_snmpcommunity.php, include/help/es/help_wmiquery.php, + include/help/es/help_map_builder.php, include/help/es/help_postprocess.php, + include/help/es/help_date_format.php, + include/help/es/help_alert_recovery.php, + include/help/es/help_prediction_source_module.php, + include/help/es/help_module_type.php, + include/help/es/help_planned_downtime.php, + include/help/es/help_alert-matches.php, include/help/es/help_recontask.php, + include/help/es/help_alerts.php, include/help/es/help_serverlag.php, + include/help/es/help_snmpwalk.php, + include/help/es/help_module_definition.php, + include/help/es/help_tcp_send.php, include/help/es/help_duplicateconfig.php, + include/help/es/help_wmifield.php, include/help/es/help_manage_alerts.php, + include/help/es/help_wmikey.php, include/help/es/help_plugin_definition.php, + include/help/es/help_alert_type.php, include/help/es/help_snmpoid.php, + include/help/es/help_wminamespace.php, + include/help/es/help_network_component.php, + include/help/es/help_time_stamp-comparation.php, + include/help/es/help_manageconfig.php, include/help/es/help_timesource.php, + include/config_process.php, include/functions_ui.php, include/htmlawed.php, + include/functions_custom_graphs.php, include/fgraph.php, + include/functions_incidents.php, include/functions.php, + include/functions_agents.php, include/functions_db.php, + include/functions_themes.php, include/streams.php, + include/functions_fsgraph.php, include/functions_alerts.php, + include/functions_reports.php, include/functions_extensions.php, + include/functions_ui_renders.php: change comments blocks for delete the + warnings to construct phpDoc Files, give a struct and order in the + phpDoc files. + 2009-08-24 Sancho Lerena * operation/agentes/alerts_status.php: Show description instead name, diff --git a/pandora_console/include/FusionCharts/FusionCharts.php b/pandora_console/include/FusionCharts/FusionCharts.php index aa174c5f50..b856779c0f 100644 --- a/pandora_console/include/FusionCharts/FusionCharts.php +++ b/pandora_console/include/FusionCharts/FusionCharts.php @@ -1,13 +1,19 @@ -Both are similars: -get_db_all_rows_filter ('table', array ('disabled', 0)); -get_db_all_rows_filter ('table', 'disabled = 0'); - -Both are similars: -get_db_all_rows_filter ('table', array ('disabled' => 0, 'history_data' => 0), 'name', 'OR'); -get_db_all_rows_filter ('table', 'disabled = 0 OR history_data = 0', 'name'); - + * + * Both are similars: + * get_db_all_rows_filter ('table', array ('disabled', 0)); + * get_db_all_rows_filter ('table', 'disabled = 0'); + * + * Both are similars: + * get_db_all_rows_filter ('table', array ('disabled' => 0, 'history_data' => 0), 'name', 'OR'); + * get_db_all_rows_filter ('table', 'disabled = 0 OR history_data = 0', 'name'); + * * @param mixed Fields of the table to retrieve. Can be an array or a coma * separated string. All fields are retrieved by default * @param string Condition of the filter (AND, OR). @@ -1936,16 +1940,16 @@ function get_db_all_fields_in_table ($table, $field = '', $condition = '', $orde * values. Example code: * * - $values = array (); - $values['name'] = "Name"; - $values['description'] = "Long description"; - $sql = 'UPDATE table SET '.format_array_to_update_sql ($values).' WHERE id=1'; - echo $sql; - + * $values = array (); + * $values['name'] = "Name"; + * $values['description'] = "Long description"; + * $sql = 'UPDATE table SET '.format_array_to_update_sql ($values).' WHERE id=1'; + * echo $sql; + * * Will return: - - UPDATE table SET `name` = "Name", `description` = "Long description" WHERE id=1 - + * + * UPDATE table SET `name` = "Name", `description` = "Long description" WHERE id=1 + * * * @param array Values to be formatted in an array indexed by the field name. * @@ -3068,11 +3072,11 @@ function process_sql_insert ($table, $values) { * Examples: * * -process_sql_update ('table', array ('field' => 1), array ('id' => $id)); -process_sql_update ('table', array ('field' => 1), array ('id' => $id, 'name' => $name)); -process_sql_update ('table', array ('field' => 1), array ('id' => $id, 'name' => $name), 'OR'); -process_sql_update ('table', array ('field' => 2), 'id in (1, 2, 3) OR id > 10'); - * + * process_sql_update ('table', array ('field' => 1), array ('id' => $id)); + * process_sql_update ('table', array ('field' => 1), array ('id' => $id, 'name' => $name)); + * process_sql_update ('table', array ('field' => 1), array ('id' => $id, 'name' => $name), 'OR'); + * process_sql_update ('table', array ('field' => 2), 'id in (1, 2, 3) OR id > 10'); + * * * @param string Table to insert into * @param array An associative array of values to update @@ -3108,16 +3112,16 @@ function process_sql_update ($table, $values, $where = false, $where_join = 'AND * All values should be cleaned before passing. Quoting isn't necessary. * Examples: * - * -process_sql_delete ('table', array ('id' => 1)); -// DELETE FROM table WHERE id = 1 -process_sql_delete ('table', array ('id' => 1, 'name' => 'example')); -// DELETE FROM table WHERE id = 1 AND name = 'example' -process_sql_delete ('table', array ('id' => 1, 'name' => 'example'), 'OR'); -// DELETE FROM table WHERE id = 1 OR name = 'example' -process_sql_delete ('table', 'id in (1, 2, 3) OR id > 10'); -// DELETE FROM table WHERE id in (1, 2, 3) OR id > 10 - * + * + * process_sql_delete ('table', array ('id' => 1)); + * // DELETE FROM table WHERE id = 1 + * process_sql_delete ('table', array ('id' => 1, 'name' => 'example')); + * // DELETE FROM table WHERE id = 1 AND name = 'example' + * process_sql_delete ('table', array ('id' => 1, 'name' => 'example'), 'OR'); + * // DELETE FROM table WHERE id = 1 OR name = 'example' + * process_sql_delete ('table', 'id in (1, 2, 3) OR id > 10'); + * // DELETE FROM table WHERE id in (1, 2, 3) OR id > 10 + * * * @param string Table to insert into * @param array An associative array of values to update diff --git a/pandora_console/include/functions_events.php b/pandora_console/include/functions_events.php index 6920ca16b7..eaed0363a8 100644 --- a/pandora_console/include/functions_events.php +++ b/pandora_console/include/functions_events.php @@ -14,6 +14,33 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ + +/** + * Get all rows of events from the database, that + * pass the filter, and can get only some fields. + * + * @param mixed Filters elements. It can be an indexed array + * (keys would be the field name and value the expected value, and would be + * joined with an AND operator) or a string, including any SQL clause (without + * the WHERE keyword). Example: + * + * Both are similars: + * get_db_all_rows_filter ('table', array ('disabled', 0)); + * get_db_all_rows_filter ('table', 'disabled = 0'); + * + * Both are similars: + * get_db_all_rows_filter ('table', array ('disabled' => 0, 'history_data' => 0), 'name', 'OR'); + * get_db_all_rows_filter ('table', 'disabled = 0 OR history_data = 0', 'name'); + * + * @param mixed Fields of the table to retrieve. Can be an array or a coma + * separated string. All fields are retrieved by default + * + * + * @return mixed False in case of error or invalid values passed. Affected rows otherwise + */ function get_events ($filter = false, $fields = false) { return get_db_all_rows_filter ('tevento', $filter, $fields); } diff --git a/pandora_console/include/functions_exportserver.php b/pandora_console/include/functions_exportserver.php index f27f9037a7..9b5e8017a6 100644 --- a/pandora_console/include/functions_exportserver.php +++ b/pandora_console/include/functions_exportserver.php @@ -14,6 +14,10 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ + /** * Gets all export servers out of the database * diff --git a/pandora_console/include/functions_extensions.php b/pandora_console/include/functions_extensions.php index 4318f064d6..b958c3f292 100644 --- a/pandora_console/include/functions_extensions.php +++ b/pandora_console/include/functions_extensions.php @@ -14,6 +14,10 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ + $extension_file = ''; diff --git a/pandora_console/include/functions_filemanager.php b/pandora_console/include/functions_filemanager.php index e96cc5d81f..1972a44681 100644 --- a/pandora_console/include/functions_filemanager.php +++ b/pandora_console/include/functions_filemanager.php @@ -14,10 +14,18 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ + +/**#@+ + * Constants + */ define ('MIME_UNKNOWN', 0); define ('MIME_DIR', 1); define ('MIME_IMAGE', 2); define ('MIME_ZIP', 3); +/**#@-*/ if (!function_exists ('mime_content_type')) { /** diff --git a/pandora_console/include/functions_fsgraph.php b/pandora_console/include/functions_fsgraph.php index 1b0890f8a7..b82c8e21c5 100644 --- a/pandora_console/include/functions_fsgraph.php +++ b/pandora_console/include/functions_fsgraph.php @@ -14,6 +14,13 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ + +/** + * Include the FusionCharts class + */ require_once ('FusionCharts/FusionCharts_Gen.php'); // Returns the code needed to display the chart diff --git a/pandora_console/include/functions_html.php b/pandora_console/include/functions_html.php index 43b9b95618..84b8af769b 100644 --- a/pandora_console/include/functions_html.php +++ b/pandora_console/include/functions_html.php @@ -15,7 +15,11 @@ // GNU General Public License for more details. /** - * Prints the print_r with
 tags
+ * @package Include
+ */
+
+/**
+ * Prints the print_r with < pre > tags
  */
 function debugPrint ($var) {
 	echo "
";print_r($var);echo "
"; diff --git a/pandora_console/include/functions_incidents.php b/pandora_console/include/functions_incidents.php index 351c46f9ae..76af1aa8ba 100644 --- a/pandora_console/include/functions_incidents.php +++ b/pandora_console/include/functions_incidents.php @@ -14,6 +14,10 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ + /** * Gets all the possible priorities for incidents in an array * diff --git a/pandora_console/include/functions_menu.php b/pandora_console/include/functions_menu.php index 1edb4b50a2..144b360076 100644 --- a/pandora_console/include/functions_menu.php +++ b/pandora_console/include/functions_menu.php @@ -14,6 +14,10 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ + /** * Prints a complete menu structure. * diff --git a/pandora_console/include/functions_messages.php b/pandora_console/include/functions_messages.php index db91dabf5b..f985dc5b69 100644 --- a/pandora_console/include/functions_messages.php +++ b/pandora_console/include/functions_messages.php @@ -14,6 +14,10 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ + /** * Creates a private message to be forwarded to other people * diff --git a/pandora_console/include/functions_modules.php b/pandora_console/include/functions_modules.php index 1379b3cfe0..0a8f7a7d76 100644 --- a/pandora_console/include/functions_modules.php +++ b/pandora_console/include/functions_modules.php @@ -14,6 +14,10 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ + /** * Copy a module defined in an agent to other agent. * diff --git a/pandora_console/include/functions_network_components.php b/pandora_console/include/functions_network_components.php index 242fbbe260..539cd0cdf7 100644 --- a/pandora_console/include/functions_network_components.php +++ b/pandora_console/include/functions_network_components.php @@ -13,7 +13,13 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ +/** + * Include modules functions + */ require_once ('include/functions_modules.php'); /** diff --git a/pandora_console/include/functions_network_profiles.php b/pandora_console/include/functions_network_profiles.php index 0557b44f7a..eab93e90a7 100644 --- a/pandora_console/include/functions_network_profiles.php +++ b/pandora_console/include/functions_network_profiles.php @@ -14,6 +14,9 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ /** * Get a network profile. diff --git a/pandora_console/include/functions_networkmap.php b/pandora_console/include/functions_networkmap.php index d9c440e3f8..af0e20995b 100644 --- a/pandora_console/include/functions_networkmap.php +++ b/pandora_console/include/functions_networkmap.php @@ -14,6 +14,13 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ + +/** + * Include agents function + */ require_once ('functions_agents.php'); require_css_file ('cluetip'); require_jquery_file ('cluetip'); diff --git a/pandora_console/include/functions_reporting.php b/pandora_console/include/functions_reporting.php index 5f76f3a811..f2e3597a09 100644 --- a/pandora_console/include/functions_reporting.php +++ b/pandora_console/include/functions_reporting.php @@ -14,6 +14,13 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ + +/** + * Include the usual functions + */ require_once ($config["homedir"]."/include/functions.php"); require_once ($config["homedir"]."/include/functions_db.php"); require_once ($config["homedir"]."/include/functions_agents.php"); diff --git a/pandora_console/include/functions_reports.php b/pandora_console/include/functions_reports.php index 48f15a16df..887586f969 100644 --- a/pandora_console/include/functions_reports.php +++ b/pandora_console/include/functions_reports.php @@ -14,6 +14,10 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ + /** * Get a custom user report. * diff --git a/pandora_console/include/functions_servers.php b/pandora_console/include/functions_servers.php index dba0a68591..3847ef704f 100644 --- a/pandora_console/include/functions_servers.php +++ b/pandora_console/include/functions_servers.php @@ -14,6 +14,10 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ + /** * Get a server. * diff --git a/pandora_console/include/functions_themes.php b/pandora_console/include/functions_themes.php index ae6f0befe2..86ecd86847 100644 --- a/pandora_console/include/functions_themes.php +++ b/pandora_console/include/functions_themes.php @@ -14,6 +14,10 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ + /** * Get a list of CSS themes installed. * diff --git a/pandora_console/include/functions_ui.php b/pandora_console/include/functions_ui.php index b8eb052c07..8145207bfc 100644 --- a/pandora_console/include/functions_ui.php +++ b/pandora_console/include/functions_ui.php @@ -14,6 +14,10 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ + /** * Prints a generic message between tags. * diff --git a/pandora_console/include/functions_ui_renders.php b/pandora_console/include/functions_ui_renders.php index be0cfefbb6..fed1beeb1f 100644 --- a/pandora_console/include/functions_ui_renders.php +++ b/pandora_console/include/functions_ui_renders.php @@ -14,6 +14,9 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ /** */ diff --git a/pandora_console/include/functions_visual_map.php b/pandora_console/include/functions_visual_map.php index b57b5bbb78..a6baccf528 100644 --- a/pandora_console/include/functions_visual_map.php +++ b/pandora_console/include/functions_visual_map.php @@ -14,6 +14,9 @@ // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. +/** + * @package Include + */ /** * Prints visual map diff --git a/pandora_console/include/gettext.php b/pandora_console/include/gettext.php index ad94a987b7..9dc697f699 100644 --- a/pandora_console/include/gettext.php +++ b/pandora_console/include/gettext.php @@ -1,4 +1,8 @@ . Copyright (c) 2005 Nico Kaiser @@ -32,6 +36,8 @@ * While the cache is enabled by default, it can be switched off with the * second parameter in the constructor (e.g. whenusing very large MO files * that you don't want to keep in memory) + * + * @package Include */ class gettext_reader { //public: diff --git a/pandora_console/include/help/en/help_agent_status.php b/pandora_console/include/help/en/help_agent_status.php index 6c401ed5d0..5d4c4a24a3 100644 --- a/pandora_console/include/help/en/help_agent_status.php +++ b/pandora_console/include/help/en/help_agent_status.php @@ -1,3 +1,8 @@ +

Agent status view

Possible values of an agent status are: diff --git a/pandora_console/include/help/en/help_alert-matches.php b/pandora_console/include/help/en/help_alert-matches.php index f173b777bd..e395f70842 100755 --- a/pandora_console/include/help/en/help_alert-matches.php +++ b/pandora_console/include/help/en/help_alert-matches.php @@ -1,3 +1,8 @@ +

Matches of the alert

diff --git a/pandora_console/include/help/en/help_alert_recovery.php b/pandora_console/include/help/en/help_alert_recovery.php index 61d764051b..293d78898d 100644 --- a/pandora_console/include/help/en/help_alert_recovery.php +++ b/pandora_console/include/help/en/help_alert_recovery.php @@ -1,3 +1,8 @@ +

Alert recovery

It defines whether Pandora FMS launches another alert when the alert condition is recovered. It has the same field1, but adds "[RECOVER]" to field2 and field3. It is disabled by default. diff --git a/pandora_console/include/help/en/help_alert_type.php b/pandora_console/include/help/en/help_alert_type.php index 57047bf78a..8fa8a898c0 100644 --- a/pandora_console/include/help/en/help_alert_type.php +++ b/pandora_console/include/help/en/help_alert_type.php @@ -1,3 +1,8 @@ +

Alert type

There are some predefined alerts, in which is very likely you will have to adjust, in case your system does not provide the internal commands needed to execute those alerts. The development team has tested these alerts with Red Hat Enterprise Linux (RHEL), CentOS, Debian and Ubuntu Server. diff --git a/pandora_console/include/help/en/help_alert_validation.php b/pandora_console/include/help/en/help_alert_validation.php index 34f8c9a191..df667c3dcb 100644 --- a/pandora_console/include/help/en/help_alert_validation.php +++ b/pandora_console/include/help/en/help_alert_validation.php @@ -1,3 +1,8 @@ +

Alert validation

ACK an alert only changes it's current bit and clear the "fired", so if alert fired again, the process continues. It's oriented to alerts with a long threshold, for example 1 day. If you get an alarm, and you review and fix it, you probably want to set to green status and don't wait 1 day to get green again. diff --git a/pandora_console/include/help/en/help_alerts.php b/pandora_console/include/help/en/help_alerts.php index 7203e60407..9a2a897ac5 100644 --- a/pandora_console/include/help/en/help_alerts.php +++ b/pandora_console/include/help/en/help_alerts.php @@ -1,3 +1,8 @@ +

Alerts

Assigning Alerts to modules diff --git a/pandora_console/include/help/en/help_date_format.php b/pandora_console/include/help/en/help_date_format.php index 4171c0b341..4303e56e66 100644 --- a/pandora_console/include/help/en/help_date_format.php +++ b/pandora_console/include/help/en/help_date_format.php @@ -1,3 +1,8 @@ +

The format of the outputted date string. See the formatting options below. diff --git a/pandora_console/include/help/en/help_duplicateconfig.php b/pandora_console/include/help/en/help_duplicateconfig.php index d076dc9633..08ae804221 100644 --- a/pandora_console/include/help/en/help_duplicateconfig.php +++ b/pandora_console/include/help/en/help_duplicateconfig.php @@ -1,3 +1,8 @@ +

Source agent

Only agents that have uploaded their configuration to the server will be shown. diff --git a/pandora_console/include/help/en/help_eventview.php b/pandora_console/include/help/en/help_eventview.php index d4a9e35aab..a29419d316 100644 --- a/pandora_console/include/help/en/help_eventview.php +++ b/pandora_console/include/help/en/help_eventview.php @@ -1,3 +1,8 @@ +

Event viewer



diff --git a/pandora_console/include/help/en/help_manage_alerts.php b/pandora_console/include/help/en/help_manage_alerts.php index 0646247694..8c03bd786f 100644 --- a/pandora_console/include/help/en/help_manage_alerts.php +++ b/pandora_console/include/help/en/help_manage_alerts.php @@ -1,3 +1,8 @@ +

Alerts

Alerts in Pandora FMS react to an "out of range" module value. The alert can consist of sending an e-mail or an SMS to the administrator, sending a SNMP trap, write the incident into the system log or into Pandora FMS log file, etc. Basically, an alert can be anything that can be triggered by a script configured in the Operating System where Pandora FMS Servers run. diff --git a/pandora_console/include/help/en/help_manageconfig.php b/pandora_console/include/help/en/help_manageconfig.php index 9d63ad5faa..198dea47ef 100644 --- a/pandora_console/include/help/en/help_manageconfig.php +++ b/pandora_console/include/help/en/help_manageconfig.php @@ -1,3 +1,8 @@ +

Configuration management

This tool is used to several purposes:

diff --git a/pandora_console/include/help/en/help_map_builder.php b/pandora_console/include/help/en/help_map_builder.php index ae07b6b726..6f5e961e20 100644 --- a/pandora_console/include/help/en/help_map_builder.php +++ b/pandora_console/include/help/en/help_map_builder.php @@ -1,3 +1,8 @@ +

Map builder

To create a map, you must first fill the form providing: diff --git a/pandora_console/include/help/en/help_module_definition.php b/pandora_console/include/help/en/help_module_definition.php index 6601989c8e..e488d4abbb 100644 --- a/pandora_console/include/help/en/help_module_definition.php +++ b/pandora_console/include/help/en/help_module_definition.php @@ -1,3 +1,8 @@ +

Module definition

There are two modes for an agent: diff --git a/pandora_console/include/help/en/help_module_type.php b/pandora_console/include/help/en/help_module_type.php index e039086835..d65f4638ad 100644 --- a/pandora_console/include/help/en/help_module_type.php +++ b/pandora_console/include/help/en/help_module_type.php @@ -1,3 +1,8 @@ +

Module type

The following list describes the module types: diff --git a/pandora_console/include/help/en/help_network_component.php b/pandora_console/include/help/en/help_network_component.php index 11fea399db..99fd49e7d5 100644 --- a/pandora_console/include/help/en/help_network_component.php +++ b/pandora_console/include/help/en/help_network_component.php @@ -1,3 +1,8 @@ +

Network Component

The Network Component combo box allows you to select a template from a list of more than a hundred and automatically fill some fields with the typical values. diff --git a/pandora_console/include/help/en/help_planned_downtime.php b/pandora_console/include/help/en/help_planned_downtime.php index ce675e10fe..0dd0fa4dac 100644 --- a/pandora_console/include/help/en/help_planned_downtime.php +++ b/pandora_console/include/help/en/help_planned_downtime.php @@ -1,3 +1,8 @@ +

Scheduled downtimes

diff --git a/pandora_console/include/help/en/help_plugin_definition.php b/pandora_console/include/help/en/help_plugin_definition.php index 1ce6b79291..d3cc159de3 100644 --- a/pandora_console/include/help/en/help_plugin_definition.php +++ b/pandora_console/include/help/en/help_plugin_definition.php @@ -1,3 +1,8 @@ +

Plugin registration

Pandora FMS Plugin registration tool is used to define what parameters Pandora FMS Plugin server needs to be used in each plugin, and what kind of data will pass after that parameter. diff --git a/pandora_console/include/help/en/help_plugin_parameters.php b/pandora_console/include/help/en/help_plugin_parameters.php index 2d9c479dd0..b3f1b289d4 100644 --- a/pandora_console/include/help/en/help_plugin_parameters.php +++ b/pandora_console/include/help/en/help_plugin_parameters.php @@ -1,3 +1,8 @@ +

Plugin parameters

This field reffers to all parameters that can be passed to a plugin and are not defined in the form, unlike Port, Password, Max. timeout... diff --git a/pandora_console/include/help/en/help_postprocess.php b/pandora_console/include/help/en/help_postprocess.php index 5f45610607..3b5f3b5bcd 100644 --- a/pandora_console/include/help/en/help_postprocess.php +++ b/pandora_console/include/help/en/help_postprocess.php @@ -1,3 +1,8 @@ +

Post process

Post process is a numeric value used after get data to numerical post process in a multiplier operation. For example a data with a value of 1000 with a Post Process value of 1024 will result in a definitive data of 1024000 value. This is useful to normalize data, convert between units, etc. This also can be used to divide, using a multiplier below 1 value, like, for example, 0.001 that will divide current value by 1000. diff --git a/pandora_console/include/help/en/help_prediction_source_module.php b/pandora_console/include/help/en/help_prediction_source_module.php index 99a9065255..baa17803e3 100644 --- a/pandora_console/include/help/en/help_prediction_source_module.php +++ b/pandora_console/include/help/en/help_prediction_source_module.php @@ -1,3 +1,8 @@ +

Source type

diff --git a/pandora_console/include/help/en/help_recontask.php b/pandora_console/include/help/en/help_recontask.php index 4f3a1bf75a..2e387f3b99 100644 --- a/pandora_console/include/help/en/help_recontask.php +++ b/pandora_console/include/help/en/help_recontask.php @@ -1,3 +1,8 @@ +

Recon Task

diff --git a/pandora_console/include/help/en/help_serverlag.php b/pandora_console/include/help/en/help_serverlag.php index 5641d849c0..1d997dda77 100644 --- a/pandora_console/include/help/en/help_serverlag.php +++ b/pandora_console/include/help/en/help_serverlag.php @@ -1,3 +1,8 @@ +

Server Lag

Server lag has 2 values. The first value (usually the larger one) shows how much seconds the modules are in the queue for that server, the second value show how many modules are in the queue.

diff --git a/pandora_console/include/help/en/help_snmpcommunity.php b/pandora_console/include/help/en/help_snmpcommunity.php index d0c9fbd963..49db88f0f0 100644 --- a/pandora_console/include/help/en/help_snmpcommunity.php +++ b/pandora_console/include/help/en/help_snmpcommunity.php @@ -1,3 +1,8 @@ +

SNMP Community

Community needed to monitor a SNMP OID. diff --git a/pandora_console/include/help/en/help_snmpoid.php b/pandora_console/include/help/en/help_snmpoid.php index cb9ff982aa..e638854d21 100644 --- a/pandora_console/include/help/en/help_snmpoid.php +++ b/pandora_console/include/help/en/help_snmpoid.php @@ -1,3 +1,8 @@ +

SNMP OID

Module's SNMP OID. If there is a MIB able to resolve the name in Pandora FMS Network Server, then you can use alphanumeric OIDs (i.e. SNMPv2-MIB::sysDescr.0). Numeric OID can always be used (i.e. 3.1.3.1.3.5.12.4.0.1), even if there is no specific MIB. diff --git a/pandora_console/include/help/en/help_snmpwalk.php b/pandora_console/include/help/en/help_snmpwalk.php index 063d4f6a72..8963a448f4 100644 --- a/pandora_console/include/help/en/help_snmpwalk.php +++ b/pandora_console/include/help/en/help_snmpwalk.php @@ -1,3 +1,8 @@ +

SNMP walk

Pandora FMS has also a simple SNMP browser that allows to walk the MIB of a remote device by a SNMP Walk. diff --git a/pandora_console/include/help/en/help_tcp_send.php b/pandora_console/include/help/en/help_tcp_send.php index b8a6159692..b3a199e152 100644 --- a/pandora_console/include/help/en/help_tcp_send.php +++ b/pandora_console/include/help/en/help_tcp_send.php @@ -1,3 +1,8 @@ +

TCP Check

diff --git a/pandora_console/include/help/en/help_time_stamp-comparation.php b/pandora_console/include/help/en/help_time_stamp-comparation.php index 32cf5d0718..1f7b9792f1 100644 --- a/pandora_console/include/help/en/help_time_stamp-comparation.php +++ b/pandora_console/include/help/en/help_time_stamp-comparation.php @@ -1,3 +1,8 @@ +

Timestamp or time comparation

diff --git a/pandora_console/include/help/en/help_timesource.php b/pandora_console/include/help/en/help_timesource.php index 71a6fdca3c..1996e19ec3 100644 --- a/pandora_console/include/help/en/help_timesource.php +++ b/pandora_console/include/help/en/help_timesource.php @@ -1,3 +1,8 @@ +

Origen de tiempo

diff --git a/pandora_console/include/help/en/help_wmifield.php b/pandora_console/include/help/en/help_wmifield.php index dbc2d93783..4fea5afe76 100644 --- a/pandora_console/include/help/en/help_wmifield.php +++ b/pandora_console/include/help/en/help_wmifield.php @@ -1,3 +1,8 @@ +

Field number

Row number to retrieve from the WQL query result (starting from zero). diff --git a/pandora_console/include/help/en/help_wmikey.php b/pandora_console/include/help/en/help_wmikey.php index bd9138dd18..a5ac72d7c3 100644 --- a/pandora_console/include/help/en/help_wmikey.php +++ b/pandora_console/include/help/en/help_wmikey.php @@ -1,3 +1,8 @@ +

Key string

Optional. Substring to look for in the WQL query result. The module returns 1 if found, 0 if not. \ No newline at end of file diff --git a/pandora_console/include/help/en/help_wminamespace.php b/pandora_console/include/help/en/help_wminamespace.php index 5c5bb5784c..b78afbfe72 100644 --- a/pandora_console/include/help/en/help_wminamespace.php +++ b/pandora_console/include/help/en/help_wminamespace.php @@ -1,3 +1,8 @@ +

Key string

Optional. WMI namespace. If unsure leave blank. \ No newline at end of file diff --git a/pandora_console/include/help/en/help_wmiquery.php b/pandora_console/include/help/en/help_wmiquery.php index 73c7d4a76d..fa7fc04075 100644 --- a/pandora_console/include/help/en/help_wmiquery.php +++ b/pandora_console/include/help/en/help_wmiquery.php @@ -1,3 +1,8 @@ +

WMI Query

diff --git a/pandora_console/include/help/es/help_alert-matches.php b/pandora_console/include/help/es/help_alert-matches.php index 8c41d45c55..2f39f4f3af 100644 --- a/pandora_console/include/help/es/help_alert-matches.php +++ b/pandora_console/include/help/es/help_alert-matches.php @@ -1,3 +1,8 @@ +

Coincidencias de la alerta

diff --git a/pandora_console/include/help/es/help_alert_recovery.php b/pandora_console/include/help/es/help_alert_recovery.php index 73e697632b..3666c30eb0 100644 --- a/pandora_console/include/help/es/help_alert_recovery.php +++ b/pandora_console/include/help/es/help_alert_recovery.php @@ -1,3 +1,8 @@ +

Recuperación de alerta

Define si Pandora FMS lanza otra alerta cuando la condición de la alerta se recupera. Tiene el mismo «campo1» pero añade «[RECOVER]]» al «campo2» y al «campo3». De forma predeterminada está desactivada. diff --git a/pandora_console/include/help/es/help_alert_type.php b/pandora_console/include/help/es/help_alert_type.php index 054eb07abe..438a5d07e3 100644 --- a/pandora_console/include/help/es/help_alert_type.php +++ b/pandora_console/include/help/es/help_alert_type.php @@ -1,3 +1,8 @@ +

Tipo de alerta

Existen algunas alertas predefinidas, las cuales es muy probable que tenga que configurar en caso de que su sistema no proporcione los comandos necesarios para ejecutarlas. El equipo de desarrollo ha probado estas alertas con Red Hat Enterprise Linux (RHEL), CentOS, Debian y Ubuntu Server. diff --git a/pandora_console/include/help/es/help_alert_validation.php b/pandora_console/include/help/es/help_alert_validation.php index 6c012c07ad..7e3a349bf1 100644 --- a/pandora_console/include/help/es/help_alert_validation.php +++ b/pandora_console/include/help/es/help_alert_validation.php @@ -1,3 +1,8 @@ +

Validación de alerta

Validar una alerta sólo cambia su bit de estado y limpia el estado «disparado», de tal forma que si la alerta se dispara de nuevo el proceso continua. Está orientado a alertas con grandes umbrales, por ejemplo, 1 día. Si obtiene una alarma y la revisa y la marca como vista, probablemente quiera establecer su estado a verde y no quiere esperar 1 día a que se vuelva a poner verde. diff --git a/pandora_console/include/help/es/help_alerts.php b/pandora_console/include/help/es/help_alerts.php index 975e9e929a..1ed568a44d 100644 --- a/pandora_console/include/help/es/help_alerts.php +++ b/pandora_console/include/help/es/help_alerts.php @@ -1,3 +1,8 @@ +

Alertas

Asignar alertas a módulos diff --git a/pandora_console/include/help/es/help_date_format.php b/pandora_console/include/help/es/help_date_format.php index 0636dc0d56..54dc7b80a8 100644 --- a/pandora_console/include/help/es/help_date_format.php +++ b/pandora_console/include/help/es/help_date_format.php @@ -1,3 +1,8 @@ +

El formato de la salida de la cadena de fecha. Consulte las opciones de formato debajo.

diff --git a/pandora_console/include/help/es/help_duplicateconfig.php b/pandora_console/include/help/es/help_duplicateconfig.php index dd6c315579..6e67a8a852 100644 --- a/pandora_console/include/help/es/help_duplicateconfig.php +++ b/pandora_console/include/help/es/help_duplicateconfig.php @@ -1,3 +1,8 @@ +

Agente origen

Sólo se mostrarán los agentes que han cargado su configuración en el servidor. diff --git a/pandora_console/include/help/es/help_manage_alerts.php b/pandora_console/include/help/es/help_manage_alerts.php index babe5d1c78..f0334cede1 100644 --- a/pandora_console/include/help/es/help_manage_alerts.php +++ b/pandora_console/include/help/es/help_manage_alerts.php @@ -1,3 +1,8 @@ +

Alertas

Las alertas en Pandora FMS reaccionan ante un valor «fuera de rango». La alerta puede consistir del envío de un correo-e o un SMS al administrador, enviar un trap SNMP, escribir un incidente en el fichero log del sistema o en el log de Pandora FMS, etc. Básicamente, una alerta puede ser cualquier cosa que se pueda dispoarar desde un script configurado en el Sistema Operativo donde Pandora FMS se ejecuta. diff --git a/pandora_console/include/help/es/help_manageconfig.php b/pandora_console/include/help/es/help_manageconfig.php index 48b0348997..953e81a50c 100644 --- a/pandora_console/include/help/es/help_manageconfig.php +++ b/pandora_console/include/help/es/help_manageconfig.php @@ -1,3 +1,8 @@ +

Gestión de la configuración

Ésta herramienta se usa para diversos propoósitos:

diff --git a/pandora_console/include/help/es/help_map_builder.php b/pandora_console/include/help/es/help_map_builder.php index 02ebebf79f..336823666d 100644 --- a/pandora_console/include/help/es/help_map_builder.php +++ b/pandora_console/include/help/es/help_map_builder.php @@ -1,3 +1,8 @@ +

Constructor de mapas

Para crear un mapa primero debe rellenar el formulario proporcionando: diff --git a/pandora_console/include/help/es/help_module_definition.php b/pandora_console/include/help/es/help_module_definition.php index c0fc6e514e..1354902d68 100644 --- a/pandora_console/include/help/es/help_module_definition.php +++ b/pandora_console/include/help/es/help_module_definition.php @@ -1,3 +1,8 @@ +

Definición de módulo

diff --git a/pandora_console/include/help/es/help_module_type.php b/pandora_console/include/help/es/help_module_type.php index 90f187c36e..d32f81b69c 100644 --- a/pandora_console/include/help/es/help_module_type.php +++ b/pandora_console/include/help/es/help_module_type.php @@ -1,3 +1,8 @@ +

Tipo de módulo

La siguiente lista describe los tipos de módulos: diff --git a/pandora_console/include/help/es/help_network_component.php b/pandora_console/include/help/es/help_network_component.php index 15310bbe95..90ffef2eab 100644 --- a/pandora_console/include/help/es/help_network_component.php +++ b/pandora_console/include/help/es/help_network_component.php @@ -1,3 +1,8 @@ +

Componente de red

diff --git a/pandora_console/include/help/es/help_planned_downtime.php b/pandora_console/include/help/es/help_planned_downtime.php index 07143abf4b..6ab7308ede 100644 --- a/pandora_console/include/help/es/help_planned_downtime.php +++ b/pandora_console/include/help/es/help_planned_downtime.php @@ -1,3 +1,8 @@ +

Desconexiones programadas

diff --git a/pandora_console/include/help/es/help_plugin_definition.php b/pandora_console/include/help/es/help_plugin_definition.php index 5f6f41903f..4bc50f04b9 100644 --- a/pandora_console/include/help/es/help_plugin_definition.php +++ b/pandora_console/include/help/es/help_plugin_definition.php @@ -1,3 +1,8 @@ +

Registro de complementos

La herramienta de registro de Pandora FMS se usa para definir los parámetros que el servidor de complementos de Pandora FMS necestia usar con cada complemento, y qué tipo de datos se le pasarán posteriormente después del parámetro. diff --git a/pandora_console/include/help/es/help_plugin_parameters.php b/pandora_console/include/help/es/help_plugin_parameters.php index 44b582fb37..3a63b58a34 100644 --- a/pandora_console/include/help/es/help_plugin_parameters.php +++ b/pandora_console/include/help/es/help_plugin_parameters.php @@ -1,3 +1,8 @@ +

Parámetros del complemento

Este campo hace referencia a todos los parámetros que se le pueden pasar al complemento y no están definidos en el formularo, a diferencia de «Puerto», «Contraseña», «Máx. tiempo de expiración», ... diff --git a/pandora_console/include/help/es/help_postprocess.php b/pandora_console/include/help/es/help_postprocess.php index 77803a4d96..cd3991156c 100644 --- a/pandora_console/include/help/es/help_postprocess.php +++ b/pandora_console/include/help/es/help_postprocess.php @@ -1,3 +1,8 @@ +

Posprocesado

El posprocesado es un valor numérico usado después de obtener el dato para posprocesar dicho dato de forma numérica en una multiplicación. Por ejemplo, datos con un valor de 1000 con un valor de Posprocesado de 1024 darán como resultado un valor final de 1024000. Esto es útil para normalizar los datos, convertir entre unidades, etc. Esto también se puede usar para dividir, usando un valor de multiplicador inferior a 1, como, por ejemplo, 0.001 que dividirá el valor actual por 1000. diff --git a/pandora_console/include/help/es/help_prediction_source_module.php b/pandora_console/include/help/es/help_prediction_source_module.php index a7c12f6774..57ec112385 100644 --- a/pandora_console/include/help/es/help_prediction_source_module.php +++ b/pandora_console/include/help/es/help_prediction_source_module.php @@ -1,3 +1,8 @@ +

Módulo origen

diff --git a/pandora_console/include/help/es/help_recontask.php b/pandora_console/include/help/es/help_recontask.php index 7256557d8c..55c71ac39f 100644 --- a/pandora_console/include/help/es/help_recontask.php +++ b/pandora_console/include/help/es/help_recontask.php @@ -1,3 +1,8 @@ +

Tarea de reconocimiento (recon)

diff --git a/pandora_console/include/help/es/help_serverlag.php b/pandora_console/include/help/es/help_serverlag.php index 4ea3a015c1..51871eb363 100644 --- a/pandora_console/include/help/es/help_serverlag.php +++ b/pandora_console/include/help/es/help_serverlag.php @@ -1,3 +1,8 @@ +

Retardo del servidor

El retardo del servidor tiene dos valores. El primer valor (generalmente el más largo) muestra los segundos que los módulos están en la cola para ese servidor, el segundo valor muestra el número de módulos en la cola.

diff --git a/pandora_console/include/help/es/help_snmpcommunity.php b/pandora_console/include/help/es/help_snmpcommunity.php index 9a0d84c14d..def2ff985e 100644 --- a/pandora_console/include/help/es/help_snmpcommunity.php +++ b/pandora_console/include/help/es/help_snmpcommunity.php @@ -1,3 +1,8 @@ +

Comunidad SNMP

Comunidad necesaria parra monitorizar un OID SNMP. diff --git a/pandora_console/include/help/es/help_snmpoid.php b/pandora_console/include/help/es/help_snmpoid.php index 736170626e..afd43da1b2 100644 --- a/pandora_console/include/help/es/help_snmpoid.php +++ b/pandora_console/include/help/es/help_snmpoid.php @@ -1,3 +1,8 @@ +

OID SNMP

La OID SNMP del módulo. Si existe una MIB capaz de resolver el nombre en el servidor de red de Pandora FMS, entonces puede usar OID alfanumércias (ej. SNMPv2-MIB::sysDescr.0). Siempre se pueden usar OID numéricas (ej. 3.1.3.1.3.5.12.4.0.1), incluso si no hay una MIB específica. \ No newline at end of file diff --git a/pandora_console/include/help/es/help_snmpwalk.php b/pandora_console/include/help/es/help_snmpwalk.php index 427d645cb1..de07ceef69 100644 --- a/pandora_console/include/help/es/help_snmpwalk.php +++ b/pandora_console/include/help/es/help_snmpwalk.php @@ -1,3 +1,8 @@ +

SNMP walk

Pandora FMS también tiene un examinador SNMP simple que permite hacer un «walk» de un dispositivo remoto a través de un SNMP walk. diff --git a/pandora_console/include/help/es/help_tcp_send.php b/pandora_console/include/help/es/help_tcp_send.php index 81005acaf6..78365dbd21 100644 --- a/pandora_console/include/help/es/help_tcp_send.php +++ b/pandora_console/include/help/es/help_tcp_send.php @@ -1,3 +1,8 @@ +

Comprobación TCP

diff --git a/pandora_console/include/help/es/help_time_stamp-comparation.php b/pandora_console/include/help/es/help_time_stamp-comparation.php index 8d92f89212..d6259550c1 100644 --- a/pandora_console/include/help/es/help_time_stamp-comparation.php +++ b/pandora_console/include/help/es/help_time_stamp-comparation.php @@ -1,3 +1,8 @@ +

Marca de tiempo o comparación de hora

diff --git a/pandora_console/include/help/es/help_timesource.php b/pandora_console/include/help/es/help_timesource.php index 69d1598318..ed6c3fe9ad 100644 --- a/pandora_console/include/help/es/help_timesource.php +++ b/pandora_console/include/help/es/help_timesource.php @@ -1,3 +1,8 @@ +

Origen de tiempo

diff --git a/pandora_console/include/help/es/help_wmifield.php b/pandora_console/include/help/es/help_wmifield.php index 0f84c1f96e..88e4c0cf68 100644 --- a/pandora_console/include/help/es/help_wmifield.php +++ b/pandora_console/include/help/es/help_wmifield.php @@ -1,3 +1,8 @@ +

Campo número

Número de fila que obtener desde el resultado de la consulta WQL (empezando desde cero). diff --git a/pandora_console/include/help/es/help_wmikey.php b/pandora_console/include/help/es/help_wmikey.php index d86008c345..28e7d4122f 100644 --- a/pandora_console/include/help/es/help_wmikey.php +++ b/pandora_console/include/help/es/help_wmikey.php @@ -1,3 +1,8 @@ +

Texto clave

Opcional. Subcadena en la buscar el resultado de la consulta WQL. El módulo devuelve 1 si se encuentra, de lo contrario devuelve 0. diff --git a/pandora_console/include/help/es/help_wminamespace.php b/pandora_console/include/help/es/help_wminamespace.php index ed65c1f97f..df1b262e27 100644 --- a/pandora_console/include/help/es/help_wminamespace.php +++ b/pandora_console/include/help/es/help_wminamespace.php @@ -1,3 +1,8 @@ +

Texto clave

Opcional. Espacio de nombres (namespace) WMI. Si no está seguro, déjelo en blanco. diff --git a/pandora_console/include/help/es/help_wmiquery.php b/pandora_console/include/help/es/help_wmiquery.php index e5746a2ecc..07b585e2ee 100644 --- a/pandora_console/include/help/es/help_wmiquery.php +++ b/pandora_console/include/help/es/help_wmiquery.php @@ -1,3 +1,8 @@ +

Consulta WMI

Cualquier consulta WQL válida. Según Microsot, el lenguaje de consultas WMI (WQL) es un subconjunto del estándar ANSI SQL (American National Standards Institute Structured Query Language), con mínimos cambios semánticos para soportar WMI. diff --git a/pandora_console/include/htmlawed.php b/pandora_console/include/htmlawed.php index 3a132074dd..fe0067b55b 100755 --- a/pandora_console/include/htmlawed.php +++ b/pandora_console/include/htmlawed.php @@ -1,14 +1,18 @@ . @@ -20,9 +24,12 @@ */ - -// Simple class to wrap file streams, string streams, etc. -// seek is essential, and it should be byte stream +/** + * Simple class to wrap file streams, string streams, etc. + * seek is essential, and it should be byte stream + * @package Include + * @subpackage Streams + */ class StreamReader { // should return a string [FIXME: perhaps return array of bytes?] function read($bytes) { @@ -45,6 +52,10 @@ class StreamReader { } } +/** + * @package Include + * @subpackage Streams + */ class StringReader { var $_pos; var $_str; @@ -80,7 +91,10 @@ class StringReader { } - +/** + * @package Include + * @subpackage Streams + */ class FileReader { var $_pos; var $_fd; @@ -139,8 +153,12 @@ class FileReader { } -// Preloads entire file in memory first, then creates a StringReader -// over it (it assumes knowledge of StringReader internals) +/** + * Preloads entire file in memory first, then creates a StringReader + * over it (it assumes knowledge of StringReader internals) + * @package Include + * @subpackage Streams + */ class CachedFileReader extends StringReader { function CachedFileReader($filename) { if (file_exists($filename)) {