From 9b1975aed7f720ad31b4fd5c1d64cee0c9db942c Mon Sep 17 00:00:00 2001 From: ramonn Date: Wed, 14 Aug 2013 16:25:07 +0000 Subject: [PATCH] 2013-08-14 Ramon Novoa * godmode/agentes/module_manager_editor_plugin.php, include/help/ja/help_web_checks.php, include/help/ja/help_plugin_macros.php, include/help/en/help_plugin_macros.php, include/help/en/help_web_checks.php, include/help/en/help_snmp_alert_field1.php, include/help/es/help_plugin_macros.php, include/help/es/help_snmp_alert_field1.php, include/help/es/help_web_checks.php: Updated help files. git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@8664 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f --- pandora_console/ChangeLog | 12 ++++++ .../agentes/module_manager_editor_plugin.php | 2 +- .../include/help/en/help_plugin_macros.php | 31 ++++++++++++++++ .../help/en/help_snmp_alert_field1.php | 2 + .../include/help/en/help_web_checks.php | 37 +++++++++++++++++-- .../include/help/es/help_plugin_macros.php | 29 +++++++++++++++ .../help/es/help_snmp_alert_field1.php | 3 +- .../include/help/es/help_web_checks.php | 35 ++++++++++++++++-- .../include/help/ja/help_plugin_macros.php | 30 +++++++++++++++ .../include/help/ja/help_web_checks.php | 36 ++++++++++++++++-- 10 files changed, 204 insertions(+), 13 deletions(-) create mode 100644 pandora_console/include/help/en/help_plugin_macros.php create mode 100644 pandora_console/include/help/es/help_plugin_macros.php create mode 100644 pandora_console/include/help/ja/help_plugin_macros.php diff --git a/pandora_console/ChangeLog b/pandora_console/ChangeLog index bc839ffad2..8741045846 100644 --- a/pandora_console/ChangeLog +++ b/pandora_console/ChangeLog @@ -1,3 +1,15 @@ +2013-08-14 Ramon Novoa + + * godmode/agentes/module_manager_editor_plugin.php, + include/help/ja/help_web_checks.php, + include/help/ja/help_plugin_macros.php, + include/help/en/help_plugin_macros.php, + include/help/en/help_web_checks.php, + include/help/en/help_snmp_alert_field1.php, + include/help/es/help_plugin_macros.php, + include/help/es/help_snmp_alert_field1.php, + include/help/es/help_web_checks.php: Updated help files. + 2013-08-14 Koichiro Kikuchi * index.php: Improve footer layout. diff --git a/pandora_console/godmode/agentes/module_manager_editor_plugin.php b/pandora_console/godmode/agentes/module_manager_editor_plugin.php index 551076d504..0a34a260ac 100644 --- a/pandora_console/godmode/agentes/module_manager_editor_plugin.php +++ b/pandora_console/godmode/agentes/module_manager_editor_plugin.php @@ -44,7 +44,7 @@ else { $extra_title = __('Plugin server module'); $data = array (); -$data[0] = __('Plugin'); +$data[0] = __('Plugin') . ui_print_help_icon ('plugin_macros', true); $data[1] = html_print_select_from_sql ('SELECT id, name FROM tplugin ORDER BY name', 'id_plugin', $id_plugin, 'changePluginSelect();', __('None'), 0, true, false, false, $disabledBecauseInPolicy); // Store the macros in base64 into a hidden control to move between pages diff --git a/pandora_console/include/help/en/help_plugin_macros.php b/pandora_console/include/help/en/help_plugin_macros.php new file mode 100644 index 0000000000..888a5eb69a --- /dev/null +++ b/pandora_console/include/help/en/help_plugin_macros.php @@ -0,0 +1,31 @@ + +

Plug-in macros

+ +

+The following macros are available: +

    +
  • _agent_ : Name of the agent that fired the alert.
    • +
  • _agentdescription_ : Description of the agent who fired alert.
    • +
  • _agentgroup_ : Agent group name.
    • +
  • _agentstatus_ : Current status of the agent.
    • +
  • _address_ : Address of the agent that fired the alert.
    • +
  • _module_ : Module name.
    • +
  • _modulegroup_ : Module group name.
    • +
  • _moduledescription_ : Description of the module who fired the alert.
    • +
  • _modulestatus_ : Status of the module.
    • +
  • _moduletags_ : Tags associated to the module.
    • +
  • _id_agent_ : Id of agent, useful to build direct URL to redirect to a Pandora FMS console webpage.
    • +
  • _policy_ : Name of the policy the module belongs to (if applies).
    • +
  • _interval_ : Execution interval of the module.
    • +
  • _target_ip_ : IP address of the target of the module.
    • +
  • _target_port_ : Port number of the target of the module.
    • +
  • _plugin_parameters_ : Plug-in Parameters of the module.
    • +
  • _email_tag_ : Emails associated to the module tags.
    • + +
+

+

diff --git a/pandora_console/include/help/en/help_snmp_alert_field1.php b/pandora_console/include/help/en/help_snmp_alert_field1.php index 2386719e55..7fda1567a2 100644 --- a/pandora_console/include/help/en/help_snmp_alert_field1.php +++ b/pandora_console/include/help/en/help_snmp_alert_field1.php @@ -18,4 +18,6 @@ You can use these macros in FieldX (1-10) of any alert _AGENT_: Agent name
_IP_: IP Address
_TIMESTAMP_: Trap date
+_SNMP_OID_: Trap OID
+_SNMP_VALUE_: Trap OID value

diff --git a/pandora_console/include/help/en/help_web_checks.php b/pandora_console/include/help/en/help_web_checks.php index 7de63a2557..3148293e92 100644 --- a/pandora_console/include/help/en/help_web_checks.php +++ b/pandora_console/include/help/en/help_web_checks.php @@ -12,8 +12,6 @@ This is a sample of GOLIAT Webcheck module: 

-
-
 task_begin
 post http://galaga.artica.es/pandora/index.php?login=1
 variable_name nick
@@ -30,6 +28,39 @@ cookie 1
 resource 1
 check_string Read messages
 task_end
+
+

+The following macros are available: +

    +
  • _agent_ : Name of the agent that fired the alert.
    • +
  • _agentdescription_ : Description of the agent who fired alert.
    • +
  • _agentgroup_ : Agent group name.
    • +
  • _agentstatus_ : Current status of the agent.
    • +
  • _address_ : Address of the agent that fired the alert.
    • +
  • _module_ : Module name.
    • +
  • _modulegroup_ : Module group name.
    • +
  • _moduledescription_ : Description of the module who fired the alert.
    • +
  • _modulestatus_ : Status of the module.
    • +
  • _moduletags_ : Tags associated to the module.
    • +
  • _id_agent_ : Id of agent, useful to build direct URL to redirect to a Pandora FMS console webpage.
    • +
  • _policy_ : Name of the policy the module belongs to (if applies).
    • +
  • _interval_ : Execution interval of the module.
    • +
  • _target_ip_ : IP address of the target of the module.
    • +
  • _target_port_ : Port number of the target of the module.
    • +
  • _plugin_parameters_ : Plug-in Parameters of the module.
    • +
  • _email_tag_ : Emails associated to the module tags.
    • - \ No newline at end of file +
+

+

+

+For example: +

+task_begin
+get http://_address_
+check_string _module_
+task_end
+
+
+

diff --git a/pandora_console/include/help/es/help_plugin_macros.php b/pandora_console/include/help/es/help_plugin_macros.php new file mode 100644 index 0000000000..1a00fa6792 --- /dev/null +++ b/pandora_console/include/help/es/help_plugin_macros.php @@ -0,0 +1,29 @@ + +

Macros de plug-in

+ +

+Las siguientes macros están disponibles: +

+
    +
  • _agentdescription_ : Descripción del agente que disparó la alerta.
    • +
  • _agentgroup_ : Nombre del grupo del agente.
    • +
  • _agentstatus_ : Estado actual del agente.
    • +
  • _address_: Dirección del agente que disparó la alerta.
    • +
  • _module_: Nombre del módulo
    • +
  • _modulegroup_ : Nombre del grupo del módulo.
    • +
  • _moduledescription_: Descripcion del modulo.
    • +
  • _modulestatus_ : Estado del módulo.
    • +
  • _moduletags_ : Etiquetas asociadas al módulo.
    • +
  • _id_agent_: ID del agente, util para construir URL de acceso a la consola de Pandora.
    • +
  • _policy_: Nombre de la política a la que pertenece el módulo (si aplica).
    • +
  • _interval_ : Intervalo de la ejecución del módulo.
    • +
  • _target_ip_ : Dirección IP del objetivo del módulo.
    • +
  • _target_port_ : Puerto del objetivo del módulo.
    • +
  • _plugin_parameters_ : Parámetros del Plug-in del módulo.
    • +
  • _email_tag_ : Emails asociados a los tags de módulos.
    • + +
diff --git a/pandora_console/include/help/es/help_snmp_alert_field1.php b/pandora_console/include/help/es/help_snmp_alert_field1.php index 4bbbf468c6..56ff976a1c 100644 --- a/pandora_console/include/help/es/help_snmp_alert_field1.php +++ b/pandora_console/include/help/es/help_snmp_alert_field1.php @@ -18,5 +18,6 @@ Puede usar esas macros en los campos FieldX (1-10) de cualquier alerta. _AGENT_: Nombre del Agente
_IP_: Dirección IP
_TIMESTAMP_: Fecha trap
- +_SNMP_OID_: OID del trap
+_SNMP_VALUE_: Valor del OID del trap

diff --git a/pandora_console/include/help/es/help_web_checks.php b/pandora_console/include/help/es/help_web_checks.php index fef95021e1..051a16166f 100644 --- a/pandora_console/include/help/es/help_web_checks.php +++ b/pandora_console/include/help/es/help_web_checks.php @@ -13,8 +13,6 @@ Este es un ejemplo del modulo Webcheck de GOLIAT: 

-
-
 task_begin
 post http://galaga.artica.es/pandora/index.php?login=1
 variable_name nick
@@ -31,6 +29,35 @@ cookie 1
 resource 1
 check_string Read messages
 task_end
+
+

+Las siguientes macros están disponibles: +

+
    +
  • _agentdescription_ : Descripción del agente que disparó la alerta.
    • +
  • _agentgroup_ : Nombre del grupo del agente.
    • +
  • _agentstatus_ : Estado actual del agente.
    • +
  • _address_: Dirección del agente que disparó la alerta.
    • +
  • _module_: Nombre del módulo
    • +
  • _modulegroup_ : Nombre del grupo del módulo.
    • +
  • _moduledescription_: Descripcion del modulo.
    • +
  • _modulestatus_ : Estado del módulo.
    • +
  • _moduletags_ : Etiquetas asociadas al módulo.
    • +
  • _id_agent_: ID del agente, util para construir URL de acceso a la consola de Pandora.
    • +
  • _policy_: Nombre de la política a la que pertenece el módulo (si aplica).
    • +
  • _interval_ : Intervalo de la ejecución del módulo.
    • +
  • _target_ip_ : Dirección IP del objetivo del módulo.
    • +
  • _target_port_ : Puerto del objetivo del módulo.
    • +
  • _plugin_parameters_ : Parámetros del Plug-in del módulo.
    • +
  • _email_tag_ : Emails asociados a los tags de módulos.
    • - - \ No newline at end of file +
+

+Por ejemplo: +

+task_begin
+get http://_address_
+check_string _module_
+task_end
+
+

diff --git a/pandora_console/include/help/ja/help_plugin_macros.php b/pandora_console/include/help/ja/help_plugin_macros.php new file mode 100644 index 0000000000..239bda1715 --- /dev/null +++ b/pandora_console/include/help/ja/help_plugin_macros.php @@ -0,0 +1,30 @@ + +

プラグインマクロ

+ +

+次のマクロが利用できます: +

+
    +
  • _agent_ : アラートが発生したエージェント
    • +
  • _agentdescription_ : 発生したアラートの説明
    • +
  • _agentgroup_ : エージェントグループ名
    • +
  • _agentstatus : エージェントの現在の状態
    • +
  • _address_ : アラートが発生したエージェントのアドレス
    • +
  • _module_ : モジュール名
    • +
  • _modulegroup_ : モジュールグループ名
    • +
  • _moduledescription_ : アラートが発生したモジュールの説明
    • +
  • _modulestatus_ : モジュールの状態
    • +
  • _moduletags_ : モジュールに関連付けられたタグ
    • +
  • _id_agent_ : エージェントのID / Webコンソールへのリンクを生成するのに便利です
    • +
  • _policy_ : モジュールが属するポリシー名 (存在する場合)
    • +
  • _interval_ : モジュールの実行間隔
    • +
  • _target_ip_ : モジュールの対象IPアドレス
    • +
  • _target_port_ : モジュールの対象ポート
    • +
  • _plugin_parameters_ : モジュールのプラグインパラメータ
    • +
  • _email_tag_ : モジュールタグに関連付けられた Email。
    • + +
diff --git a/pandora_console/include/help/ja/help_web_checks.php b/pandora_console/include/help/ja/help_web_checks.php index e6df74fa5b..9c297a382b 100644 --- a/pandora_console/include/help/ja/help_web_checks.php +++ b/pandora_console/include/help/ja/help_web_checks.php @@ -12,8 +12,6 @@ 

-
-
 task_begin
 post http://galaga.artica.es/pandora/index.php?login=1
 variable_name nick
@@ -30,6 +28,36 @@ cookie 1
 resource 1
 check_string Read messages
 task_end
-
-
+

+次のマクロが利用できます: +

+
    +
  • _agent_ : アラートが発生したエージェント
    • +
  • _agentdescription_ : 発生したアラートの説明
    • +
  • _agentgroup_ : エージェントグループ名
    • +
  • _agentstatus : エージェントの現在の状態
    • +
  • _address_ : アラートが発生したエージェントのアドレス
    • +
  • _module_ : モジュール名
    • +
  • _modulegroup_ : モジュールグループ名
    • +
  • _moduledescription_ : アラートが発生したモジュールの説明
    • +
  • _modulestatus_ : モジュールの状態
    • +
  • _moduletags_ : モジュールに関連付けられたタグ
    • +
  • _id_agent_ : エージェントのID / Webコンソールへのリンクを生成するのに便利です
    • +
  • _policy_ : モジュールが属するポリシー名 (存在する場合)
    • +
  • _interval_ : モジュールの実行間隔
    • +
  • _target_ip_ : モジュールの対象IPアドレス
    • +
  • _target_port_ : モジュールの対象ポート
    • +
  • _plugin_parameters_ : モジュールのプラグインパラメータ
    • +
  • _email_tag_ : モジュールタグに関連付けられた Email。
    • + +
+

+例: +

+task_begin
+get http://_address_
+check_string _module_
+task_end
+
+