From 4137d64d7ecff5e7e71da88fcd0e790451520014 Mon Sep 17 00:00:00 2001 From: ramonn Date: Wed, 11 Sep 2013 12:22:48 +0000 Subject: [PATCH] 2013-09-11 Ramon Novoa * godmode/agentes/module_manager_editor.php, include/help/en/help_alert_config.php, include/help/en/help_alert_macros.php, include/help/en/help_module_macros.php, include/help/es/help_module_macros.php, include/help/es/help_alert_config.php, include/help/es/help_alert_macros.php, include/help/ja/help_alert_macros.php, include/help/ja/help_module_macros.php, include/help/ja/help_alert_config.php: Updated help for module macros. git-svn-id: https://svn.code.sf.net/p/pandora/code/trunk@8758 c3f86ba8-e40f-0410-aaad-9ba5e7f4b01f --- pandora_console/ChangeLog | 13 ++++ .../godmode/agentes/module_manager_editor.php | 2 +- .../include/help/en/help_alert_config.php | 2 +- .../include/help/en/help_alert_macros.php | 2 +- .../include/help/en/help_module_macros.php | 21 ++++++ .../include/help/es/help_alert_config.php | 2 +- .../include/help/es/help_alert_macros.php | 2 +- .../include/help/es/help_module_macros.php | 21 ++++++ .../include/help/ja/help_alert_config.php | 68 +++++++++++++++++++ .../include/help/ja/help_alert_macros.php | 2 +- .../include/help/ja/help_module_macros.php | 21 ++++++ 11 files changed, 150 insertions(+), 6 deletions(-) create mode 100644 pandora_console/include/help/en/help_module_macros.php create mode 100644 pandora_console/include/help/es/help_module_macros.php create mode 100644 pandora_console/include/help/ja/help_alert_config.php create mode 100644 pandora_console/include/help/ja/help_module_macros.php diff --git a/pandora_console/ChangeLog b/pandora_console/ChangeLog index 8278afa57c..1d486015e4 100644 --- a/pandora_console/ChangeLog +++ b/pandora_console/ChangeLog @@ -1,3 +1,16 @@ +2013-09-11 Ramon Novoa + + * godmode/agentes/module_manager_editor.php, + include/help/en/help_alert_config.php, + include/help/en/help_alert_macros.php, + include/help/en/help_module_macros.php, + include/help/es/help_module_macros.php, + include/help/es/help_alert_config.php, + include/help/es/help_alert_macros.php, + include/help/ja/help_alert_macros.php, + include/help/ja/help_module_macros.php, + include/help/ja/help_alert_config.php: Updated help for module macros. + 2013-09-10 Juan Manuel Ramon * godmode/admin_access_logs.php: Fixed php error that breaks diff --git a/pandora_console/godmode/agentes/module_manager_editor.php b/pandora_console/godmode/agentes/module_manager_editor.php index ae3a176f07..7e9102e720 100644 --- a/pandora_console/godmode/agentes/module_manager_editor.php +++ b/pandora_console/godmode/agentes/module_manager_editor.php @@ -426,7 +426,7 @@ echo '
'; html_print_table ($table_simple); ui_toggle(html_print_table ($table_advanced, true), __('Advanced options')); -ui_toggle(html_print_table ($table_macros, true), __('Module macros')); +ui_toggle(html_print_table ($table_macros, true), __('Module macros') . ui_print_help_icon ('module_macros', true)); // Submit diff --git a/pandora_console/include/help/en/help_alert_config.php b/pandora_console/include/help/en/help_alert_config.php index f9be567707..c6941c3821 100644 --- a/pandora_console/include/help/en/help_alert_config.php +++ b/pandora_console/include/help/en/help_alert_config.php @@ -23,7 +23,7 @@ Within these fields we can configure the macros listed below.

-The following macros are available: +Besides the defined module macros, the following macros are available:

  • _field1_ : User defined field 1.
  • _field2_ : User defined field 2.
    • diff --git a/pandora_console/include/help/en/help_alert_macros.php b/pandora_console/include/help/en/help_alert_macros.php index 6e354ee842..efb598ee49 100644 --- a/pandora_console/include/help/en/help_alert_macros.php +++ b/pandora_console/include/help/en/help_alert_macros.php @@ -6,7 +6,7 @@

    Alert macros

    -The following macros are available: +Besides the defined module macros, the following macros are available:

    • _field1_ : User defined field 1.
    • _field2_ : User defined field 2.
      • diff --git a/pandora_console/include/help/en/help_module_macros.php b/pandora_console/include/help/en/help_module_macros.php new file mode 100644 index 0000000000..6de1e5c064 --- /dev/null +++ b/pandora_console/include/help/en/help_module_macros.php @@ -0,0 +1,21 @@ + +

      Module macros

      + +Any number of custom module macros may be defined. The recommended format for macro names is: + +
      +_macroname_
+
      + +For example: +
        +
      • _technology_
        • +
      • _modulepriority_
        • +
      • _contactperson_
        • +
      + +This macros can be used in module alerts. diff --git a/pandora_console/include/help/es/help_alert_config.php b/pandora_console/include/help/es/help_alert_config.php index 4e29bdfb37..4551630f28 100644 --- a/pandora_console/include/help/es/help_alert_config.php +++ b/pandora_console/include/help/es/help_alert_config.php @@ -23,7 +23,7 @@ A la hora de crear la acción podemos definir únicamente estos 3 campos. Dentro

      -Las siguientes macros están disponibles: +Además de las macros de módulo definidas, las siguientes macros están disponibles:

      • _field1_: Campo 1 definido por el usuario.
        • diff --git a/pandora_console/include/help/es/help_alert_macros.php b/pandora_console/include/help/es/help_alert_macros.php index b3549178f2..896fa4c8bc 100644 --- a/pandora_console/include/help/es/help_alert_macros.php +++ b/pandora_console/include/help/es/help_alert_macros.php @@ -6,7 +6,7 @@

        Macros de alertas

        -Las siguientes macros están disponibles: +Además de las macros de módulo definidas, las siguientes macros están disponibles:

        • _field1_: Campo 1 definido por el usuario.
          • diff --git a/pandora_console/include/help/es/help_module_macros.php b/pandora_console/include/help/es/help_module_macros.php new file mode 100644 index 0000000000..cd82368a82 --- /dev/null +++ b/pandora_console/include/help/es/help_module_macros.php @@ -0,0 +1,21 @@ + +

          Macros de módulo

          + +Se puede definir cualquier número de macros de módulo. El formato recomendado para los nombres de macros es el siguiente: + +
          +_macroname_
+
          + +Por ejemplo: +
            +
          • _technology_
            • +
          • _modulepriority_
            • +
          • _contactperson_
            • +
          + +Estas macros se pueden utilizar en las alertas de módulos. diff --git a/pandora_console/include/help/ja/help_alert_config.php b/pandora_console/include/help/ja/help_alert_config.php new file mode 100644 index 0000000000..981094206c --- /dev/null +++ b/pandora_console/include/help/ja/help_alert_config.php @@ -0,0 +1,68 @@ + +

          Configure Alert Action

          +
          Actions are the components of alerts where a command (which is described in the previous section) is linked with the generic variables Field 1, Field 2, ..., Field 10. These actions will be used later in the alert templates that are the ones that associate a data condition with an specific action.
          +Next are the fields that you should fill in:

          + + Name: Name of the action.
          + Group: Group of the action.
          + Command: In this field is defined the command that will be used in case the alert will be executed . You can choose between the different commands that are defined in Pandora.Depending of the command chosen we will have some or others fields to fill.
          + Threshold: The action execution threshold.
          + Command Preview: In this field, not editable, will automatically appear the command that will be executed in the system.
          + Field X: In this fields are defined the values of the macros _field1_ to _field10_, that will be used in the command if necessary. These fields can be a text field or combo box if configured. Depending on the selected command will appear a number of fields to fill in as needed or not. For example:

          + +To configure email action, you can only fill _field1_ (Destination address), _field2_ (Subject) y _field3_ (Message)

          + +Within these fields we can configure the macros listed below. +

          + '550px')); ?> +

          +
          + +

          +Besides the defined module macros, the following macros are available: +

            +
          • _field1_ : User defined field 1.
            • +
          • _field2_ : User defined field 2.
            • +
          • _field3_ : User defined field 3.
            • +
          • _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.
            • +
          • _timestamp_ : Time when the alert was fired (yy-mm-dd hh:mm:ss).
            • +
          • _data_ : Module data that caused the alert to fire.
            • +
          • _alert_description_ : Alert description.
            • +
          • _alert_threshold_ : Alert threshold.
            • +
          • _alert_times_fired_ : Number of times the alert has been fired.
            • +
          • _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.
            • +
          • _alert_name_ : Alert name.
            • +
          • _alert_priority_ : Numerical alert priority.
            • +
          • _alert_text_severity_ : Text alert severity (Maintenance, Informational, Normal Minor, Warning, Major, Critical).
            • +
          • _event_text_severity_ : (Only event alerts) Text event (who fire the alert) severity (Maintenance, Informational, Normal Minor, Warning, Major, Critical).
            • +
          • _event_id_ : (Only event alerts) Id of the event that fired the alert.
            • +
          • _id_agent_ : Id of agent, useful to build direct URL to redirect to a Pandora FMS console webpage.
            • +
          • _id_alert_ : Numerical ID of the alert (unique), used to correlate on third party software
            • +
          • _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.
            • +
          • _groupcontact_ : Group contact information. Configured when the group is created.
            • +
          • _groupother_ : Other information about the group. Configured when the group is created.
            • +
          • _email_tag_ : Emails associated to the module tags.
            • + +
          +

          +

          +

          +Example: Agent _agent_ has fired alert _alert_ with data _data_ +

          + diff --git a/pandora_console/include/help/ja/help_alert_macros.php b/pandora_console/include/help/ja/help_alert_macros.php index 10fe1a7a33..be934554fc 100644 --- a/pandora_console/include/help/ja/help_alert_macros.php +++ b/pandora_console/include/help/ja/help_alert_macros.php @@ -6,7 +6,7 @@

          アラートマクロ

          -次のマクロが利用できます: +Besides the defined module macros, 次のマクロが利用できます:

          • _field1_ : ユーザ定義フィールド1
            • diff --git a/pandora_console/include/help/ja/help_module_macros.php b/pandora_console/include/help/ja/help_module_macros.php new file mode 100644 index 0000000000..b8d66560e9 --- /dev/null +++ b/pandora_console/include/help/ja/help_module_macros.php @@ -0,0 +1,21 @@ + +

            Module macros

            + +Any number of custom module macros may be defined. The recommended format for macro names is: + +
            +_macroname_
+
            + +For example: +
              +
            • _technology_
              • +
            • _modulepriority_
              • +
            • _contactperson_
              • +
            + +This macros can be used in module alerts.