Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
en:documentation:08_technical_reference:03_anexo_cli [2021/04/26 08:16]
0.0.0.0 creado
en:documentation:08_technical_reference:03_anexo_cli [2021/11/05 12:05] (current)
Line 1: Line 1:
-====== Pandora:Documentation_en:Anexo_CLI ======+====== Pandora FMS Command Line Interface (CLI) ====== 
 +{{indexmenu_n>3}}
  
-[[Pandora:Documentation_en|Go back to Pandora FMS documentation index]]+[[en:documentation:start|Go back to Pandora FMS documentation index]]
  
-{{WIP}}+<WRAP center round important 60%> 
 +We are working on the translation of the Pandora FMS documentation. Sorry for any inconvenience. 
 +</WRAP>
  
-= Pandora FMS CLI =+===== Pandora FMS CLI =====
  
 The Pandora FMS CLI (Command-Line Interface) is used for making calls in command line on the file **/usr/share/pandora_server/util/pandora_manage.pl**. This method is specially useful to integrate applications of thirds parts with Pandora FMS through automated tasks. Basically, it consists on one call with the parameters formated to do and action such as the creation an elimination of one agent, one module or one user, among other things. The Pandora FMS CLI (Command-Line Interface) is used for making calls in command line on the file **/usr/share/pandora_server/util/pandora_manage.pl**. This method is specially useful to integrate applications of thirds parts with Pandora FMS through automated tasks. Basically, it consists on one call with the parameters formated to do and action such as the creation an elimination of one agent, one module or one user, among other things.
Line 12: Line 15:
 The CLI is a file in Perl, so one call to CLI is as easy as this: The CLI is a file in Perl, so one call to CLI is as easy as this:
  
- perl pandora_manage.pl <pandora_server.conf path> <option> <option parameters>+  perl pandora_manage.pl <pandora_server.conf path> <option> <option parameters
 + 
 +<WRAP center round important 60%> 
 +If you are an **enterprise** customer, you will need to use the binary executable instead of the .pl, since there are some enterprise features that may not work properly with the .pl. Just run //pandora_manage// to get started. 
 +</WRAP>
  
-{{warning|If you are an **enterprise** customer, you will need to use the binary executable instead of the .pl, since there are some enterprise features that may not work properly with the .pl. Just run //pandora_manage// to get started.}} 
 Only Enterprise: Only Enterprise:
  
- pandora_manage <pandora_server.conf path> <option> <option parameters>+  pandora_manage <pandora_server.conf path> <option> <option parameters>
  
  
 Pandora FMS CLI has the following options: Pandora FMS CLI has the following options:
  
-***Agents** +  * **Agents** 
-****--create_agent:** Create an agent +    --**create_agent:** Create an agent 
-****--update_agent:** Update an agent field +    --**update_agent:** Update an agent field 
-****--delete_agent:** Delete an agent +    --**delete_agent:** Delete an agent 
-****--disable_group:** Disable all agents from one group +    --**disable_group:** Disable all agents from one group 
-****--enable_group:** Enable all agents from one group +    --**enable_group:** Enable all agents from one group 
-****--create_group:** Create a group +    --**create_group:** Create a group 
-****--delete_group:** Delete a group +    --**delete_group:** Delete a group 
-****--update_group:** Update a group +    --**update_group:** Update a group 
-****--stop_downtime:** Stop a planned downtime +    --**stop_downtime:** Stop a planned downtime 
-****--get_agent_status:**Get the status of a given agent +    --**get_agent_status:**Get the status of a given agent 
-****--get_agent_group:** Get the group name of a given agent +    --**get_agent_group:** Get the group name of a given agent 
-****--get_agent_modules:** Get the module list of a given agent +    --**get_agent_modules:** Get the module list of a given agent 
-****--get_agents:** Get list of agents with optative filter parameters +    --**get_agents:** Get list of agents with optative filter parameters 
-****--delete_conf_file:** Delete a local conf of a given agent +    --**delete_conf_file:** Delete a local conf of a given agent 
-****--clean_conf_file:** Clean a local conf of a given agent deleting all modules, policies and collections data +    --**clean_conf_file:** Clean a local conf of a given agent deleting all modules, policies and collections data 
-****--get_bad_conf_files:** Get the files bad configured (without essential tokens) +    --**get_bad_conf_files:** Get the files bad configured (without essential tokens) 
-****--migration_agent_queue:** migrate an agent from one node to another with the metaconsole (for metaconsole only) +    --**migration_agent_queue:** migrate an agent from one node to another with the metaconsole (for metaconsole only) 
-****--migration_agent:** see if there is an agent in the migration queue (only for metaconsole) +    --**migration_agent:** see if there is an agent in the migration queue (only for metaconsole) 
-****--set_disabled_and_standby:** Disable an agent and put it in standby mode ( Enterprise feature). +    --**set_disabled_and_standby:** Disable an agent and put it in standby mode ( Enterprise feature). 
-****--reset_agent_counts:** Actualiza conteos de módulo y conteos de alertas.+    --**reset_agent_counts:** Actualiza conteos de módulo y conteos de alertas.
  
-***Modules** +  * **Modules** 
-****--create_data_module:** Add one data module to one agent +    --**create_data_module:** Add one data module to one agent 
-****--create_web_module:** Add one web module to one agent +    --**create_web_module:** Add one web module to one agent 
-****--create_network_module:** Add one network module to one agent +    --**create_network_module:** Add one network module to one agent 
-****--create_network_component:** Create a new network component +    --**create_network_component:** Create a new network component 
-****--create_snmp_module:**Add one SNMP module to one agent  +    --**create_snmp_module:**Add one SNMP module to one agent  
-****--create_plugin_module:** Add one module kind plugin to one agent  +    * --**create_plugin_module:** Add one module kind plugin to one agent  
-****--get_module_group:** Displays the filtered groups of available modules +    * --**get_module_group:** Displays the filtered groups of available modules 
-****--create_module_group:** Create a group (module type) +    --**create_module_group:** Create a group (module type) 
-****--module_group_synch:** Synchronize group of modules from the meta console +    --**module_group_synch:** Synchronize group of modules from the meta console 
-****--delete_module:** Delete one module from one agent +    --**delete_module:** Delete one module from one agent 
-****--data_module:** Insert data to one module  +    --**data_module:** Insert data to one module  
-****--get_module_data:** Show data from one module in the last X seconds (interval) in CSV format +    --**get_module_data:** Show data from one module in the last X seconds (interval) in CSV format 
-****--get_module_id:** Show id from one module. +    --**get_module_id:** Show id from one module. 
-****--get_module_custom_id**: Shows the Custom ID of a module. +    --**get_module_custom_id**: Shows the Custom ID of a module. 
-****--set_module_custom_id**: Set the Custom ID of a module. If it is left blank it will remove the content that would have existed previously leaving the field empty. +    --**set_module_custom_id**: Set the Custom ID of a module. If it is left blank it will remove the content that would have existed previously leaving the field empty. 
-****--delete_data** Delete the historic data from a module, from the modules of one agent or from the modules of the agents of one group +    --**delete_data** Delete the historic data from a module, from the modules of one agent or from the modules of the agents of one group 
-****--update_module:** Update one module field+    --**update_module:** Update one module field
  
-***Alerts** +  * **Alerts** 
-****--create_template_module:** Add an alert template to an agent. +    --**create_template_module:** Add an alert template to an agent. 
-****--delete_template_module:** Delete an alert template from an agent. +    --**delete_template_module:** Delete an alert template from an agent. 
-****--create_template_action:** Create an action to one agent +    --**create_template_action:** Create an action to one agent 
-****--delete_template_action:** Delete an action from an agent +    --**delete_template_action:** Delete an action from an agent 
-****--disable_alerts:** Disable alerts in all groups. +    --**disable_alerts:** Disable alerts in all groups. 
-****--enable_alerts:** Enable alerts in all groups. +    --**enable_alerts:** Enable alerts in all groups. 
-****--create_alert_template:** Create an alert template +    --**create_alert_template:** Create an alert template 
-****--delete_alert_template:** Delete an alert template +    --**delete_alert_template:** Delete an alert template 
-****--update_alert_template:** Update field of an alert template +    --**update_alert_template:** Update field of an alert template 
-****--get_alert_actions:** Allows to visualize the actions of alerts +    --**get_alert_actions:** Allows to visualize the actions of alerts 
-****--get_alert_actions_meta:** Allows to visualize the actions of node alerts from the meta console (only for meta console). +    --**get_alert_actions_meta:** Allows to visualize the actions of node alerts from the meta console (only for meta console). 
-****--create_alert_command:** Creates an alert command  +    --**create_alert_command:** Creates an alert command  
-****--get_alert_commands:** Allows to visualize alert commands +    --**get_alert_commands:** Allows to visualize alert commands 
-****--validate_all_alerts:** Validates all the alerts +    --**validate_all_alerts:** Validates all the alerts 
-***Users** +  * **Users** 
-****--create_user:** Create one user. +    --**create_user:** Create one user. 
-****--delete_user:** Delete one user. +    --**delete_user:** Delete one user. 
-****--update_user:** Update field of a user +    --**update_user:** Update field of a user 
-****--enable_user:** Enable a given user +    --**enable_user:** Enable a given user 
-****--disable_user:** Disable a given user +    --**disable_user:** Disable a given user 
-****--meta_synch_user:** Synchronize users with nodes (Metaconsole only)  +    --**meta_synch_user:** Synchronize users with nodes (Metaconsole only)  
-****--create_profile:** Create a new profile. +    --**create_profile:** Create a new profile. 
-****--update_profile:** Update a profile. +    --**update_profile:** Update a profile. 
-****--add_profile:** Add a profile to an user. +    --**add_profile:** Add a profile to an user. 
-****--delete_profile:** Delete a profile from an user. +    --**delete_profile:** Delete a profile from an user. 
-****--add_profile_to_user:** Add a profile to a user in a group +    --**add_profile_to_user:** Add a profile to a user in a group 
-****--disable_eacl:** Disable the ACL Enterprise system. +    --**disable_eacl:** Disable the ACL Enterprise system. 
-****--enable_eacl:** Enable the ACL Enterprise system. +    --**enable_eacl:** Enable the ACL Enterprise system. 
-***Events** +  * **Events** 
-****--create_event:** Create an event. +    --**create_event:** Create an event. 
-****--validate_event:** Validate an event. +    --**validate_event:** Validate an event. 
-****--validate_event_id:** Validate an event given a event id. +    --**validate_event_id:** Validate an event given a event id. 
-****--get_event_info:**Display info about a event given a event id. +    --**get_event_info:**Display info about a event given a event id. 
-***Incidents** +  * **Incidents** 
-****--create_incident** Crete a incident +    --**create_incident** Crete a incident 
-***Policies** +  * **Policies** 
-****--create_policy:** Create a policy +    --**create_policy:** Create a policy 
-****--apply_policy** Force the application of a policy. +    --**apply_policy** Force the application of a policy. 
-****--apply_all_policies:** Add to the application queue all the policies +    --**apply_all_policies:** Add to the application queue all the policies 
-****--add_agent_to_policy:** Add an agent to a policy +    --**add_agent_to_policy:** Add an agent to a policy 
-****--add_collection_to_policy:** Add a collection to a policy +    --**add_collection_to_policy:** Add a collection to a policy 
-****--create_policy_data_module_from_local_component:** Create a data module from a local component to a policy +    --**create_policy_data_module_from_local_component:** Create a data module from a local component to a policy 
-****--delete_not_policy_modules** Delete all the modules not associated to policies from the conf file +    --**delete_not_policy_modules** Delete all the modules not associated to policies from the conf file 
-****--remove_agent_from_policy:** Eliminar un agente de una política +    --**remove_agent_from_policy:** Eliminar un agente de una política 
-****--disable_policy_alerts:** Disable all the alerts from a policy +    --**disable_policy_alerts:** Disable all the alerts from a policy 
-****--create_policy_data_module:** Create a policy data module +    --**create_policy_data_module:** Create a policy data module 
-****--create_policy_web_module:** Create a policy web module +    --**create_policy_web_module:** Create a policy web module 
-****--create_policy_network_module:** Create a policy network module +    --**create_policy_network_module:** Create a policy network module 
-****--create_policy_snmp_module:** Create a policy SNMP module +    --**create_policy_snmp_module:** Create a policy SNMP module 
-****--create_policy_plugin_module:** Create a policy plugin module +    --**create_policy_plugin_module:** Create a policy plugin module 
-****--validate_policy_alerts:** Validate all the alerts of a given policy +    --**validate_policy_alerts:** Validate all the alerts of a given policy 
-****--get_policy_modules:** Get the module list of a policy +    --**get_policy_modules:** Get the module list of a policy 
-****--get_policies:** Get all the policies (without parameters) or the policies of a given agent (agent name as parameter) +    --**get_policies:** Get all the policies (without parameters) or the policies of a given agent (agent name as parameter) 
-***Tools** +  * **Tools** 
-****--exec_from_file:** Execute any CLI option using macros from a CSV file +    --**exec_from_file:** Execute any CLI option using macros from a CSV file 
-***Consolas visuales** +  * **Consolas visuales** 
-****--create_visual_console:** Create a visual console in pandora following the indicated scheme +    --**create_visual_console:** Create a visual console in pandora following the indicated scheme 
-****--edit_visual_console:** Edit a visual console in pandora following the indicated scheme +    --**edit_visual_console:** Edit a visual console in pandora following the indicated scheme 
-****--delete_visual_console:** Eliminate a visual console and all its associated elements +    --**delete_visual_console:** Eliminate a visual console and all its associated elements 
-****--delete_visual_console_objects:** Remove elements associated with a visual console following a filter +    --**delete_visual_console_objects:** Remove elements associated with a visual console following a filter 
-****--duplicate_visual_console:** Duplicate a visual console as many times as indicated +    --**duplicate_visual_console:** Duplicate a visual console as many times as indicated 
-****--export_json_visual_console:** Exports a visual console and its elements to JSON format+    --**export_json_visual_console:** Exports a visual console and its elements to JSON format
  
-=====Agents===== +==== Agents ==== 
-====Create_agent==== +=== Create_agent === 
-**Parameters:** <agent_name> <operative_system> <group_name> <server_name> [[<address>|<description> <interval> <alias as name>]]+**Parameters:** <agent_name> <operative_system> <group_name> <server_name> [<address> <description> <interval> <alias as name>]
  
 **Description:** An agent with the name, the operative system, the group and the server specified will be created. Optionally, it will be possible to give it an address ( IP or name), a description and an interval in seconds (by default 300).  **Description:** An agent with the name, the operative system, the group and the server specified will be created. Optionally, it will be possible to give it an address ( IP or name), a description and an interval in seconds (by default 300). 
Line 136: Line 142:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_agent 'My agent' Windows Databases Central-Server 192.168.12.123 'Agent description' 600 0 
  
-====Update_agent====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_agent 'My agent' Windows Databases Central-Server 192.168.12.123 'Agent description' 600 0 
 + 
 +=== Update_agent ===
 (>=5.0) (>=5.0)
  
Line 148: Line 155:
  perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_agent 'Agent name' group_name 'Network'  perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_agent 'Agent name' group_name 'Network'
  
-====Delete_agent====+== Delete_agent ==
 **Parameters:** <agent_name> <use_agent_alias> **Parameters:** <agent_name> <use_agent_alias>
  
Line 154: Line 161:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_agent 'Mi agente' 
  
-====Disable_group====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_agent 'Mi agente' 
 + 
 +=== Disable_group ===
 **Parameters:** <group_name> **Parameters:** <group_name>
  
Line 162: Line 170:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_group Firewalls 
  
-====Enable_group====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_group Firewalls 
 + 
 +=== Enable_group ===
 **Parameters:** <group_name> **Parameters:** <group_name>
  
Line 170: Line 179:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_group All 
  
-====Create_group==== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_group All 
-**Parameters:** <group_name> [[<parent_group_name>|<icon> <description>]]+ 
 +=== Create_group === 
 + 
 +**Parameters:** <group_name> [<parent_group_name> <icon> <description>]
  
 **Description:** A new group will be created if it doesn't exist and optionally, can be assigned a parent group, a icon (the icon name without extension) and description. The parent group by default is 'All' and the default icon is empty string (without icon) **Description:** A new group will be created if it doesn't exist and optionally, can be assigned a parent group, a icon (the icon name without extension) and description. The parent group by default is 'All' and the default icon is empty string (without icon)
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_group 'New group' 'Parent group' 'computer' 
  
-====Delete_group====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_group 'New group' 'Parent group' 'computer' 
 + 
 +=== Delete_group ===
 **Parameters:** <group_name>  **Parameters:** <group_name> 
  
Line 186: Line 198:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_group 'New group'+  
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_group 'New group'
  
-====Update_group==== +=== Update_group === 
-**Parameters:** <group_id> [[<group_name>|<parent_group_name> <icon> <description>]]+**Parameters:** <group_id> [<group_name> <parent_group_name> <icon> <description>
  
 **Description:** A group is modified if there id (You can use the "Get_agent group_id" function to find the id of the group). The parameters that can be modified with the name, the father pointed to the icon and description. **Description:** A group is modified if there id (You can use the "Get_agent group_id" function to find the id of the group). The parameters that can be modified with the name, the father pointed to the icon and description.
Line 196: Line 209:
  perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_group 18 'Test' 'Web' 'SpiderMan' 'Description'  perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_group 18 'Test' 'Web' 'SpiderMan' 'Description'
  
-====Stop_downtime====+=== Stop_downtime ===
 (>=5.0) (>=5.0)
  
Line 204: Line 217:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --show_downtime 'Downtime name' 
  
-====Get_agent_status====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --show_downtime 'Downtime name' 
 + 
 +=== Get_agent_status ===
 (>=5.0) (>=5.0)
  
Line 214: Line 228:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agent_status 'Agent name' 
  
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agent_status 'Agent name'
  
-====Get_agent_group====+ 
 +=== Get_agent_group ===
 (>=5.0) (>=5.0)
  
Line 225: Line 240:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agent_group 'Agent name' 
  
-====Get_agent_group_id====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agent_group 'Agent name' 
 + 
 +=== Get_agent_group_id ===
 (>=5.1) (>=5.1)
  
Line 235: Line 251:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agent_group_id 'Agent name' 
  
-====Get_agent_modules====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agent_group_id 'Agent name' 
 + 
 +=== Get_agent_modules ===
 (>=5.0) (>=5.0)
  
Line 245: Line 262:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agent_modules 'Agent name' 
  
-====Get_agents====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agent_modules 'Agent name' 
 + 
 +=== Get_agents ===
 (>=5.0) (>=5.0)
  
-**Parameters:** [[<group_name>|<os_name> <status> <max_modules> <filter_substring> <policy_name> <use_agent_alias>]]+**Parameters:** [<group_name> <os_name> <status> <max_modules> <filter_substring> <policy_name> <use_agent_alias>
  
 **Description:** Get list of agents with optative filter parameters **Description:** Get list of agents with optative filter parameters
Line 257: Line 275:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agents 'Network' 'Linux' 'critical' // // 'Policy name' 
  
-====Delete_conf_file====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agents 'Network' 'Linux' 'critical' 'Policy name' 
 + 
 +=== Delete_conf_file ===
 (>=5.0) (>=5.0)
  
Line 267: Line 286:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_conf_file 'Agent name' 
  
-====Clean_conf_file====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_conf_file 'Agent name' 
 + 
 +=== Clean_conf_file ===
 (>=5.0) (>=5.0)
  
-**Parameters:** [[<agent_name>|<use_agent_alias>]]+**Parameters:**  [<agent_name> <use_agent_alias>
  
 **Description:** The conf file of one or all agents (without parameters) will be cleaned (All modules, policies, file collections and comments will be deleted). **Description:** The conf file of one or all agents (without parameters) will be cleaned (All modules, policies, file collections and comments will be deleted).
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --clean_conf_file 'Agent name' 
  
-====Get_bad_conf_files====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --clean_conf_file 'Agent name' 
 + 
 +=== Get_bad_conf_files ===
 (>=5.0) (>=5.0)
  
Line 287: Line 308:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_bad_conf_files 
  
-====migration_agent_queue====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_bad_conf_files 
 + 
 +=== migration_agent_queue ===
 (>=7.21) only for metaconsole (>=7.21) only for metaconsole
  
-**Parameters:** [[id|of the agent to migrate]][name of the source node][[name|of the destination node]][optional parameter by default this 0 will migrate the data of both the history and the db itself if it is at 1 it will only migrate those of the db itself]+**Parameters:** [id of the agent to migrate][name of the source node][name of the destination node][optional parameter by default this 0 will migrate the data of both the history and the db itself if it is at 1 it will only migrate those of the db itself] 
  
 **Description:** Add an agent to the migration queue to move from node to another node this is for the metaconsole only. To do it correctly, you will need to fill in the API configuration parameters in pandora_server.conf. **Description:** Add an agent to the migration queue to move from node to another node this is for the metaconsole only. To do it correctly, you will need to fill in the API configuration parameters in pandora_server.conf.
    
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --migration_agent_queue 1 nodo1 nodo2 0 
  
-====migration_agent====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --migration_agent_queue 1 nodo1 nodo2 0 
 + 
 +=== migration_agent ===
 (>=7.21) only for metaconsole (>=7.21) only for metaconsole
-**Parametrizes:** [[id|of the agent to check]]+**Parametrizes:** [id of the agent to check] 
  
 **Description:** it will return true or false depending on whether the agent entered exists in the agent migration table **Description:** it will return true or false depending on whether the agent entered exists in the agent migration table
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --migration_agent 1 
  
-====create_downtime====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --migration_agent 1 
 + 
 +=== create_downtime ===
 (>=5.1) (>=5.1)
  
Line 316: Line 340:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_downtime Testing Testing 05/07/2015 06/07/2015 0 1 1 1 1 1 1 1 17:06:00 19:06:00 1 31 quiet periodically weekly+ 
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_downtime Testing Testing 05/07/2015 06/07/2015 0 1 1 1 1 1 1 1 17:06:00 19:06:00 1 31 quiet periodically weekly
  
  
-====add_item_planned_downtime====+=== add_item_planned_downtime ===
 (>=5.1) (>=5.1)
  
Line 327: Line 352:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_item_downtime 1 1 'Status','AvailableMemory' 
  
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_item_downtime 1 1 'Status','AvailableMemory'
  
-====get_all_planned_downtimes====+ 
 +=== get_all_planned_downtimes ===
 (>=5.1) (>=5.1)
  
-**Parametrizes:** <name> [[<id_group>|<type_downtime> <type_execution> <type_periodicity>]]+**Parametrizes:** <name> [<id_group> <type_downtime> <type_execution> <type_periodicity>
  
 **Description:** List all matches of planned downtime. **Description:** List all matches of planned downtime.
  
 **Example:** **Example:**
-perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_all_planned_downtimes testing 0+ 
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_all_planned_downtimes testing 0
  
  
-====planned_downtimes_items====+=== planned_downtimes_items ===
 (>=5.1) (>=5.1)
  
-**Parametrizes:** <name> [[<id_group>|<type_downtime> <type_execution> <type_periodicity>]]+**Parametrizes:**  <name> [<id_group> <type_downtime> <type_execution> <type_periodicity>
  
 **Description:** List all matches of planned downtime items. **Description:** List all matches of planned downtime items.
  
 **Example:** **Example:**
-perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_planned_downtimes_items testing 0 
  
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_planned_downtimes_items testing 0
  
-====set_planned_downtimes_deleted====+ 
 +=== set_planned_downtimes_deleted ===
 (>=5.1) (>=5.1)
  
Line 360: Line 388:
  
 **Example:** **Example:**
-perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_planned_downtimes_deleted test 
  
-====set_disabled_and_standby====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_planned_downtimes_deleted test 
 + 
 +=== set_disabled_and_standby ===
 This feature is only available for Enterprise. This feature is only available for Enterprise.
  
Line 372: Line 401:
  
 **Example to enable an agent from the node:** **Example to enable an agent from the node:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 0 0+ 
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 0 0
  
 **Example to disable an agent from the node:** **Example to disable an agent from the node:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 0 1+ 
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 0 1
  
 **Example to enable an agent from the metaconsole:** **Example to enable an agent from the metaconsole:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 1 0+ 
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 1 0
  
 **Example to disable an agent from the metaconsole:** **Example to disable an agent from the metaconsole:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 1 1 
  
-====reset_agent_counts====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 1 1 
 + 
 +=== reset_agent_counts ===
 **Parameters:** <id_agent> **Parameters:** <id_agent>
  
Line 389: Line 422:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --reset_agent_counts "All" 
  
-=====Modules===== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --reset_agent_counts "All" 
-====Create_data_module==== + 
-**Parameters:** <module_name> <module_kind> <agent_name> [[<description>|<module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <def_file> <warning_str> <critical_str> <enable_unknown_events> <ff_threshold> <each_ff> <ff_threshold_normal> <ff_threshold_warning> <ff_threshold_critical> <ff_timeout> <critical_instructions> <warning_instructions> <unknown_instructions>]] <use_agent_alias>+==== Modules ==== 
 +=== Create_data_module === 
 + 
 +**Parameters:** <module_name> <module_kind> <agent_name> [<description> <module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <def_file> <warning_str> <critical_str> <enable_unknown_events> <ff_threshold> <each_ff> <ff_threshold_normal> <ff_threshold_warning> <ff_threshold_critical> <ff_timeout> <critical_instructions> <warning_instructions> <unknown_instructions>] <use_agent_alias> 
  
 **Description:** A module kind data will be created in an agent with the module name, kind of module and name of the agent where it will be created. Optionally it will be possible to give a description, the module group, min and max values, a post_process value, an interval in seconds, min and max warning values, min and max critical values, a history data value and one module definition file. **Description:** A module kind data will be created in an agent with the module name, kind of module and name of the agent where it will be created. Optionally it will be possible to give a description, the module group, min and max values, a post_process value, an interval in seconds, min and max warning values, min and max critical values, a history data value and one module definition file.
Line 399: Line 434:
 The module definition file will contain some like this: The module definition file will contain some like this:
  
- //module_begin// +<code> 
- //module_name My module// +module_begin 
- //module_type generic_data// +module_name My module 
- //module_exec cat /proc/meminfo  | grep MemFree | awk '{ print $2 }** +module_type generic_data 
- //module_end//+module_exec cat /proc/meminfo  | grep MemFree | awk '{ print $2 }' 
 +module_end 
 +</code>
  
 The default values are 0 for the minimum and maximum, history_data and post_process and 300 for the interval. The default values are 0 for the minimum and maximum, history_data and post_process and 300 for the interval.
Line 410: Line 447:
  
 The next parameters are only for the Pandora version 5 and next versions: The next parameters are only for the Pandora version 5 and next versions:
 +
   * <enable_unknown_events>   * <enable_unknown_events>
  
 The next parameters are only for the Pandora version 5.1 and next versions: The next parameters are only for the Pandora version 5.1 and next versions:
 +
   * <ff_threshold>   * <ff_threshold>
   * <each_ff>   * <each_ff>
Line 421: Line 460:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_data_module 'My module' generic_data 'My agent' 'module description' 'General' 1 3 0 300 0 0 0 0 1 /home/user/filedefinition 'string for warning' 'string for critical' + 
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_data_module 'My module' generic_data 'My agent' 'module description' 'General' 1 3 0 300 0 0 0 0 1 /home/user/filedefinition 'string for warning' 'string for critical' 
  
 If you introduce a different name or kind between the parameters and the file definition, the fixed on the file will have priority. If you introduce a different name or kind between the parameters and the file definition, the fixed on the file will have priority.
  
-====Create_web_module====+=== Create_web_module ===
 (>=7.0) (>=7.0)
  
-**Parameters:** <module_name> <module_kind> <agent_name> [[<description>|<module_group> <min> <max>[<post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <retries> <requests> <agent_browser_id> <auth_server> <auth_realm> <fichero_definicion> <proxy_url> <proxy_auth_login> <proxy_auth_password> <warning_str> <critical_str> <enable_unknown_events> <ff_threshold> <each_ff> <ff_threshold_normal> <ff_threshold_warning> <ff_threshold_critical> <ff_timeout> <ff_timeout>  <warning_inverse> <critical_inverse> <critical_instructions> <warning_instructions> <unknown_instructions>]] <use_agent_alias>+**Parameters:** <module_name> <module_kind> <agent_name> [<description> <module_group> <min> <max>[<post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <retries> <requests> <agent_browser_id> <auth_server> <auth_realm> <fichero_definicion> <proxy_url> <proxy_auth_login> <proxy_auth_password> <warning_str> <critical_str> <enable_unknown_events> <ff_threshold> <each_ff> <ff_threshold_normal> <ff_threshold_warning> <ff_threshold_critical> <ff_timeout> <ff_timeout> <warning_inverse> <critical_inverse> <critical_instructions> <warning_instructions> <unknown_instructions>] <use_agent_alias> 
  
 **Description:** A web data module will be created in an agent with the module name, kind of module and name of the agent where it will be created. Optionally it will be possible to give a description, the module group, min and max values, a post_process value, an interval in seconds, min and max warning values, min and max critical values, a history data value and one module definition file among others. **Description:** A web data module will be created in an agent with the module name, kind of module and name of the agent where it will be created. Optionally it will be possible to give a description, the module group, min and max values, a post_process value, an interval in seconds, min and max warning values, min and max critical values, a history data value and one module definition file among others.
Line 434: Line 474:
 The module definition file will contain some like this: The module definition file will contain some like this:
  
- //task_begin// +<code> 
- //get http://pandorafms.com// +task_begin 
- //task_end//+get http://pandorafms.com 
 +task_end 
 +</code>
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_web_module 'nodule_name' web_data 'pandorafms' 'module_description' 'General' 0 100 0 300 0 0 0 0 1 0 1 'Pandora FMS' auto public /home/user/ficherodefinicion '<nowiki>http://proxy.url</nowiki>' 'proxy_login' 'proxy_password' 1 10 10 10 10 10 10 10 10 1 1 'critical_instructions' 'warning_instructions' 'unknown_instructions' 
  
-====Create_network_module==== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_web_module 'nodule_name' web_data 'pandorafms' 'module_description' 'General' 0 100 0 300 0 0 0 0 1 0 1 'Pandora FMS' auto public /home/user/ficherodefinicion 'http://proxy.url' 'proxy_login' 'proxy_password' 1 10 10 10 10 10 10 10 10 1 1 'critical_instructions' 'warning_instructions' 'unknown_instructions' 
-**Parameters:** <module_name> <module_kind> <agent_name> <module_address> [[<module_port>|<description> <module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <ff_threshold> <warning_str> <critical_str> <enable_unknown_events> <each_ff> <ff_threshold_normal> <ff_treshold_warning> <ff_threshold_critical> <critical_instructions> <warning_instructions> <unknown_instructions>]] <use_agent_alias>+ 
 +=== Create_network_module === 
 +**Parameters:** <module_name> <module_kind> <agent_name> <module_address> [<module_port> <description> <module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <ff_threshold> <warning_str> <critical_str> <enable_unknown_events> <each_ff> <ff_threshold_normal> <ff_treshold_warning> <ff_threshold_critical> <critical_instructions> <warning_instructions> <unknown_instructions>] <use_agent_alias> 
  
 **Description:**  **Description:** 
Line 455: Line 498:
  
 The next parameters are only for the Pandora version 5 and next versions: The next parameters are only for the Pandora version 5 and next versions:
 +
   * <enable_unknown_events>   * <enable_unknown_events>
  
 The next parameters are only for the Pandora version 5.1 and next versions: The next parameters are only for the Pandora version 5.1 and next versions:
 +
   * <each_ff>   * <each_ff>
   * <ff_threshold_normal>   * <ff_threshold_normal>
Line 464: Line 509:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_network_module 'My module' remote_tcp 'My agent' 192.168.12.123 8080 'Module description' 'General' 1 3 0 300 0 0 0 0 1 'string for warning' 'string for critical' 
  
-====Create_network_component==== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_network_module 'My module' remote_tcp 'My agent' 192.168.12.123 8080 'Module description' 'General' 1 3 0 300 0 0 0 0 1 'string for warning' 'string for critical' 
-**Parameters:** <network_component_name> <network_component_group> <network_component_type> [[<description>|<module_interval> <max_value> <min_value> <snmp_community> <id_module_group> <max_timeout> <history_data> <min_warning> <max_warning> <str_warning> <min_critical> <max_critical> <str_critical> <min_ff_event> <post_process> <disabled_types_event> <each_ff> <min_ff_event_normal> <min_ff_event_warning> <min_ff_event_critical>]]+ 
 +=== Create_network_component === 
 +**Parameters:** <network_component_name> <network_component_group> <network_component_type> [<description> <module_interval> <max_value> <min_value> <snmp_community> <id_module_group> <max_timeout> <history_data> <min_warning> <max_warning> <str_warning> <min_critical> <max_critical> <str_critical> <min_ff_event> <post_process> <disabled_types_event> <each_ff> <min_ff_event_normal> <min_ff_event_warning> <min_ff_event_critical>] 
 + 
  
 **Description:**  **Description:** 
Line 480: Line 528:
  
 The next parameters are only for the Pandora version 5 and next versions: The next parameters are only for the Pandora version 5 and next versions:
 +
   * <enable_unknown_events>   * <enable_unknown_events>
  
 The next parameters are only for the Pandora version 5.1 and next versions: The next parameters are only for the Pandora version 5.1 and next versions:
 +
   * <each_ff>   * <each_ff>
   * <ff_threshold_normal>   * <ff_threshold_normal>
Line 489: Line 539:
  
 **Example:** **Example:**
- perl /tmp/pandorafms/pandora_server/util/pandora_manage.pl /etc/pandora/pandora_server.conf --create_network_component "example_name" 2 7 
  
-====Create_snmp_module==== +  perl /tmp/pandorafms/pandora_server/util/pandora_manage.pl /etc/pandora/pandora_server.conf --create_network_component "example_name" 2 7 
-**Parameters:** <module_name> <module_kind> <agent_name> <module_address> <module_port> <version> [[<community>|<oid> <description> <module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <snmp3_priv_method> <snmp3_priv_pass> <snmp3_sec_level> <snmp3_auth_method> <snmp3_auth_user> <snmp3_auth_pass> <ff_threshold> <warning_str> <critical_str> <enable_unknown_events> <each_ff> <ff_threshold_normal> <ff_treshold_warning> <ff_threshold_critical> <critical_instructions> <warning_instructions> <unknown_instructions>]] <use_agent_alias>+ 
 +=== Create_snmp_module === 
 +**Parameters:** <module_name> <module_kind> <agent_name> <module_address> <module_port> <version> [<community> <oid> <description> <module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <snmp3_priv_method> <snmp3_priv_pass> <snmp3_sec_level> <snmp3_auth_method> <snmp3_auth_user> <snmp3_auth_pass> <ff_threshold> <warning_str> <critical_str> <enable_unknown_events> <each_ff> <ff_threshold_normal> <ff_treshold_warning> <ff_threshold_critical> <critical_instructions> <warning_instructions> <unknown_instructions>] <use_agent_alias> 
  
 **Description:**A module kind snmp will be created in an agent with the module name, module kind, name of the agent where it will be created, the module address, the associated port and the SNMP version especified. Optionally it will be given a community, am OID, a description, the module group, min and max values, a post_process value, an interval in seconds, min and max values, critical min and max values, an history data value, and the snmp3 values like methods, passwords, etc. **Description:**A module kind snmp will be created in an agent with the module name, module kind, name of the agent where it will be created, the module address, the associated port and the SNMP version especified. Optionally it will be given a community, am OID, a description, the module group, min and max values, a post_process value, an interval in seconds, min and max values, critical min and max values, an history data value, and the snmp3 values like methods, passwords, etc.
Line 501: Line 552:
  
 The next parameters are only for the Pandora version 5 and next versions: The next parameters are only for the Pandora version 5 and next versions:
 +
   * <enable_unknown_events>   * <enable_unknown_events>
  
 The next parameters are only for the Pandora version 5.1 and next versions: The next parameters are only for the Pandora version 5.1 and next versions:
 +
   * <each_ff>   * <each_ff>
   * <ff_threshold_normal>   * <ff_threshold_normal>
Line 510: Line 563:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_snmp_module 'My module' remote_snmp_inc 'My agent' 192.168.12.123 8080 1 mycommunity myoid 'Module description' 
  
-====Create_plugin_module==== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_snmp_module 'My module' remote_snmp_inc 'My agent' 192.168.12.123 8080 1 mycommunity myoid 'Module description' 
-**Parameters:** <module_name> <module_kind> <agent_name> <module_address> <module_port> <plugin_name> <user> <password> <parameters> [[<description>|<module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <ff_threshold> <warning_str> <critical_str> <enable_unknown_events> <each_ff> <ff_threshold_normal> <ff_treshold_warning> <ff_threshold_critical> <critical_instructions> <warning_instructions> <unknown_instructions>]] <use_agent_alias>+ 
 +=== Create_plugin_module === 
 +**Parameters:** <module_name> <module_kind> <agent_name> <module_address> <module_port> <plugin_name> <user> <password> <parameters> [<description> <module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <ff_threshold> <warning_str> <critical_str> <enable_unknown_events> <each_ff> <ff_threshold_normal> <ff_treshold_warning> <ff_threshold_critical> <critical_instructions> <warning_instructions> <unknown_instructions>] <use_agent_alias> 
  
 **Description:** A module kind plugin will be created in an agent with the module name, module kind, name of the agent where it will be created, the module address, the associated port and the corresponding plugin name. Optionally it will be possible to give it a description, the module group, min and max values, a post_process value, an interval in seconds, values warning min and max, critical values min and max and a history data value. **Description:** A module kind plugin will be created in an agent with the module name, module kind, name of the agent where it will be created, the module address, the associated port and the corresponding plugin name. Optionally it will be possible to give it a description, the module group, min and max values, a post_process value, an interval in seconds, values warning min and max, critical values min and max and a history data value.
Line 531: Line 585:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_plugin_module 'My module' generic_data 'My agent' 192.168.12.123 8080 myplugin myuser mypass 'param1 param2 param3' 'Module description' 'General' 1 3 0 300 0 0 0 0 1 'string for warning' 'string for critical' 
  
-====Get_module_group==== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_plugin_module 'My module' generic_data 'My agent' 192.168.12.123 8080 myplugin myuser mypass 'param1 param2 param3' 'Module description' 'General' 1 3 0 300 0 0 0 0 1 'string for warning' 'string for critical' 
-**Parameters:** [[<nombre|del grupo de módulo>]]+ 
 +=== Get_module_group === 
 +**Parameters:** [<nombre del grupo de módulo>
  
 **Description:** Displays the available module groups. We can filter by adding the name of the group or part of it. **Description:** Displays the available module groups. We can filter by adding the name of the group or part of it.
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_group "grupo de módulos" 
  
-====Create_module_group====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_group "grupo de módulos" 
 + 
 +=== Create_module_group ===
 **Parameters:** <module_group_name> **Parameters:** <module_group_name>
  
Line 547: Line 603:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_module_group 'My module group' 
  
-====Module_group_synch==== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_module_group 'My module group' 
-**Parameters:** <server_name_1|server_name_2|...server_name_n> [[<return_type>]]+ 
 +=== Module_group_synch === 
 +**Parameters:** <server_name_1|server_name_2|...server_name_n> [<return_type>
  
 **Description:** The groups of modules of the goal will be synchronized with the nodes that have been specified in the first parameter, separated with "|". Optionally you can indicate in the second parameter the format in which the data will be returned (csv or json). By default they will come in csv format. **Description:** The groups of modules of the goal will be synchronized with the nodes that have been specified in the first parameter, separated with "|". Optionally you can indicate in the second parameter the format in which the data will be returned (csv or json). By default they will come in csv format.
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --module_group_synch "server_name1|server_name2|server_name3" "json" 
  
-====Create_synthetic====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --module_group_synch "server_name1|server_name2|server_name3" "json" 
 + 
 +=== Create_synthetic ===
 **Parameters:**  **Parameters:** 
 <module_name> <synthetic_type> <agent_name> <opts> <use_agent_alias> <module_name> <synthetic_type> <agent_name> <opts> <use_agent_alias>
Line 564: Line 622:
  
 **Examples** **Examples**
- pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module arithmetic example_agent <opts> + 
- pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module average example_agent <opts>+<code> 
 +pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module arithmetic example_agent <opts> 
 +pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module average example_agent <opts
 +</code>
  
 Let's explain all the posible parameters that can be used on the <opts>> Let's explain all the posible parameters that can be used on the <opts>>
Line 572: Line 633:
  
 **Examples** **Examples**
- pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module arithmetic example_agent my_agent,+,my_module my_agent2,-,my_module2 + 
- pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module arithmetic example_agent my_agent,+,my_module *,10 +<code> 
- pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module average example_agent my_agent,x,my_module my_agent,x,my_module2+pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module arithmetic example_agent my_agent,+,my_module my_agent2,-,my_module2 
 +pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module arithmetic example_agent my_agent,+,my_module *,10 
 +pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module average example_agent my_agent,x,my_module my_agent,x,my_module2 
 +</code>
  
 On the first example, we will create in the agent //example_agent// an arithmetic type of module named //example_module//. Its content will be the result of the operation: //my_module// - //my_module2//. On the first example, we will create in the agent //example_agent// an arithmetic type of module named //example_module//. Its content will be the result of the operation: //my_module// - //my_module2//.
Line 594: Line 658:
 **Example:** **Example:**
  
- pandora_manage /etc/pandora/pandora_server.conf --create_synthetic memory_sum arithmetic nodo51sp3 production1,+,AvailableMemory production2,+,AvailableMemory+  
 +  pandora_manage /etc/pandora/pandora_server.conf --create_synthetic memory_sum arithmetic nodo51sp3 production1,+,AvailableMemory production2,+,AvailableMemory
  
- pandora_manage /etc/pandora/pandora_server.conf --create_synthetic traffic_difference arithmetic nodo51sp3 nodo51sp3,+,InputTraffic nodo51sp3,-,OutputTraffic+  pandora_manage /etc/pandora/pandora_server.conf --create_synthetic traffic_difference arithmetic nodo51sp3 nodo51sp3,+,InputTraffic nodo51sp3,-,OutputTraffic
  
-====Delete_module====+=== Delete_module ===
 **Parameters:** <module_name> <agent_name> <use_agent_alias> **Parameters:** <module_name> <agent_name> <use_agent_alias>
  
Line 604: Line 669:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_module 'My module' 'My agent' 
  
-====Data_module==== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_module 'My module' 'My agent' 
-**Parameters:** <server_name> <agent_name> <module_name> <module_type> <module_new_data> [[<datehour>]] <use_agent_alias>+ 
 +=== Data_module === 
 +**Parameters:** <server_name> <agent_name> <module_name> <module_type> <module_new_data> [<datehour>] <use_agent_alias> 
  
 **Description:** It'll be send data to an agent module giving it as parameter the server name, the agent, the module name, the type of module amd the new data to be inserted. Optionally, it'll be possible to send the date-hour that will be as that of the data sending with 24 hours format: 'YYY-MM-DD HH:mm'. In the case of not sending this parameter, the current data will be shown. **Description:** It'll be send data to an agent module giving it as parameter the server name, the agent, the module name, the type of module amd the new data to be inserted. Optionally, it'll be possible to send the date-hour that will be as that of the data sending with 24 hours format: 'YYY-MM-DD HH:mm'. In the case of not sending this parameter, the current data will be shown.
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --data_module Servidor-General 'My agent' 'My modulo' 'generic_data' 1 '2010-05-31 15:53' 
  
-====Get_module_data====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --data_module Servidor-General 'My agent' 'My modulo' 'generic_data' 1 '2010-05-31 15:53' 
 + 
 +=== Get_module_data ===
 (>=5.0) (>=5.0)
  
-**Parameters:** <agent_name> <module_name> <interval> [[<csv_separator>]] <use_agent_alias>+**Parameters:** <agent_name> <module_name> <interval> [<csv_separator>] <use_agent_alias>
  
 **Description:** Will be returned the data of a module as 'timestamp data' in CSV format of the last X seconds (interval) using as default separator ';' **Description:** Will be returned the data of a module as 'timestamp data' in CSV format of the last X seconds (interval) using as default separator ';'
    
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_data 'agent name' 'module name' 86400 ':' 
  
-====Get_module_id====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_data 'agent name' 'module name' 86400 ':' 
 + 
 +=== Get_module_id ===
 **Parameters:** <agent_id> <module_name> **Parameters:** <agent_id> <module_name>
  
Line 630: Line 698:
    
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_id 4 'host alive' 
  
-====Get_module_custom_id====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_id 4 'host alive' 
 + 
 +=== Get_module_custom_id ===
 **Parameters:** <agentmodule_id> **Parameters:** <agentmodule_id>
  
Line 638: Line 707:
    
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_custom_id 4 
  
-====Set_module_custom_id==== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_custom_id 4 
-**Parameters:** <agentmodule_id> [[<custom_id>]]+ 
 +=== Set_module_custom_id === 
 +**Parameters:** <agentmodule_id> [<custom_id>
  
 **Description:** The value of the field //Custom ID// of a specific module of an agent will be inserted. If it is left blank it will eliminate the content that would have previously left the field empty.  **Description:** The value of the field //Custom ID// of a specific module of an agent will be inserted. If it is left blank it will eliminate the content that would have previously left the field empty. 
    
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_module_custom_id 4 '21'+ 
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_module_custom_id 4 '21'
  
  
-====Delete_data====+=== Delete_data ===
 **Parameters:** <module_name> <agent_name> | -a <agent_name> | -g <group_name> <use_agent_alias> **Parameters:** <module_name> <agent_name> | -a <agent_name> | -g <group_name> <use_agent_alias>
  
Line 655: Line 726:
  
 **Example:** **Example:**
- +  
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_data -a 'My agent'+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_data -a 'My agent'
  
 In this example all historic data will be deleted from all modules that belongs to the 'My agent' agent. In this example all historic data will be deleted from all modules that belongs to the 'My agent' agent.
  
-====Update_module====+=== Update_module ===
 **Parameters:** <module_name> <agent_name> <field_to_update> <new_value> <use_agent_alias> **Parameters:** <module_name> <agent_name> <field_to_update> <new_value> <use_agent_alias>
  
Line 674: Line 745:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_module 'Module name' 'Agent name' description 'New description' 
  
-====Get_agents_module_current_data====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_module 'Module name' 'Agent name' description 'New description' 
 + 
 +=== Get_agents_module_current_data ===
 (>=5.0) (>=5.0)
  
Line 684: Line 756:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agents_module_current_data 'Module name' 
  
-====Create_network_module_from_component====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agents_module_current_data 'Module name' 
 + 
 +=== Create_network_module_from_component ===
 (>=5.0) (>=5.0)
  
Line 694: Line 767:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_network_module_from_component 'Agent name' 
  
-====Create_data_module_from_local_component====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_network_module_from_component 'Agent name' 
 + 
 +=== Create_data_module_from_local_component ===
 (>=5.1) (>=5.1)
  
Line 704: Line 778:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_data_module_from_local_component 'Agent name' 'My local component' 
  
-====Create_local_component====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_data_module_from_local_component 'Agent name' 'My local component' 
 + 
 +=== Create_local_component ===
 (>=5.1) (>=5.1)
  
-**Parameters:** <component_name> <data> [[<description>|<id_os> <os_version> <id_network_component_group> <type> <min> <max> <module_interval> <id_module_group> <history_data> <min_warning> <max_warning> <str_warning> <min_critical> <max_critical> <str_critical> <min_ff_event> <post_process> <unit> <wizard_level> <critical_instructions> <warning_instructions> <unknown_instructions> <critical_inverse> <warning_inverse> <id_category> <disabled_types_event> <tags> <min_ff_event_normal> <min_ff_event_warning> <min_ff_event_critical> <each_ff> <ff_timeout>]]+**Parameters:** <component_name> [<description> <id_os> <os_version> <id_network_component_group> <type> <min> <max> <module_interval> <id_module_group> <history_data> <min_warning> <max_warning> <str_warning> <min_critical> <max_critical> <str_critical> <min_ff_event> <post_process> <unit> <wizard_level> <critical_instructions> <warning_instructions> <unknown_instructions> <critical_inverse> <warning_inverse> <id_category> <disabled_types_event> <tags> <min_ff_event_normal> <min_ff_event_warning> <min_ff_event_critical> <each_ff> <ff_timeout>
  
 **Description:** Create a new local component. **Description:** Create a new local component.
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_local_component 'New local component' 'module_begin\nmodule_name name\nmodule_type generic_data\nmodule_exec exec\nmodule_end' 
  
-====Apply_module_template==== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_local_component 'New local component' 'module_begin\nmodule_name name\nmodule_type generic_data\nmodule_exec exec\nmodule_end' 
-**Parameters:** [[<id_template>|<id_agent>]]+ 
 +=== Apply_module_template === 
 +**Parameters:** [<id_template> <id_agent>
  
 **Description:** Tis module templates are an agrupation that contenais network modules. This templates can be applied directly to agents, without having to include each module onw by one.  **Description:** Tis module templates are an agrupation that contenais network modules. This templates can be applied directly to agents, without having to include each module onw by one. 
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --apply_module_template 1 1 
  
-=====Alerts===== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --apply_module_template 1 1 
-====Create_template_module====+ 
 +==== Alerts ==== 
 +=== Create_template_module ===
 **Parameters:** <template_name> <module_name> <agent_name> <use_agent_alias> **Parameters:** <template_name> <module_name> <agent_name> <use_agent_alias>
  
Line 731: Line 808:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_template_module template001 'My module' 'My agent' 
  
-====Delete_template_module====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_template_module template001 'My module' 'My agent' 
 + 
 +=== Delete_template_module ===
 **Parameters:** <template_name> <module_name> <agent_name> <use_agent_alias> **Parameters:** <template_name> <module_name> <agent_name> <use_agent_alias>
  
Line 739: Line 817:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_template_module plantilla001 'Mi modulo' 'Mi agente' 
  
-====Create_template_action==== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_template_module plantilla001 'Mi modulo' 'Mi agente' 
-**Parameters:** <action_name> <template_name> <module_name> <agent_name> [[<fires_min>|<fires_max>]] <use_agent_alias>+ 
 +=== Create_template_action === 
 +**Parameters:** <action_name> <template_name> <module_name> <agent_name> [<fires_min> <fires_max>] <use_agent_alias> 
  
 **Description:** It'll be added an action to an alert giving as parameter the name of the action and that of the template, module and agent that composes the alert. It'll be also possible giving it in an optional way the values of scaling fires_min and fires_max ( by default 0). **Description:** It'll be added an action to an alert giving as parameter the name of the action and that of the template, module and agent that composes the alert. It'll be also possible giving it in an optional way the values of scaling fires_min and fires_max ( by default 0).
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_template_action action012 template001 'My module' 'My agent' 0 4 
  
-====Delete_template_action====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_template_action action012 template001 'My module' 'My agent' 0 4 
 + 
 +=== Delete_template_action ===
 **Parameters:** <action_name> <template_name> <module_name> <agent_name> <use_agent_alias> **Parameters:** <action_name> <template_name> <module_name> <agent_name> <use_agent_alias>
  
Line 755: Line 835:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_template_action action012 template001 'My module' 'My agent' 
  
-====Disable_alerts====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_template_action action012 template001 'My module' 'My agent' 
 + 
 +=== Disable_alerts ===
 **Parameters:** No **Parameters:** No
  
Line 763: Line 844:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_alerts 
  
-====Enable_alerts====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_alerts 
 + 
 +=== Enable_alerts ===
 **Parameters:** No **Parameters:** No
  
Line 771: Line 853:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_alerts 
  
-====Create_alert_template==== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_alerts 
-**Parameters:** <template_name> <condition_type_serialized> <time_from> <time_to> [[<description>|<group_name> <field1> <field2> <field3> <priority> <default_action> <days> <time_threshold> <min_alerts> <max_alerts> <alert_recovery> <field2_recovery> <field3_recovery> <condition_type_separator>]]+ 
 +=== Create_alert_template === 
 +**Parameters:** <template_name> <condition_type_serialized> <time_from> <time_to> [<description> <group_name> <field1> <field2> <field3> <priority> <default_action> <days> <time_threshold> <min_alerts> <max_alerts> <alert_recovery> <field2_recovery> <field3_recovery> <condition_type_separator>
  
 **Description:** An alert template will be created.  **Description:** An alert template will be created. 
Line 824: Line 907:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf.2011-10-25 --create_alert_template 'template name' "[email protected]@[email protected]" 09:00 18:00 "Email will be sended when the value is in the interval 3-5, between 9AM and 6PM, and only the Mondays. Separator is forced to @" "Unknown" "[email protected]" "subject" "message" 3 "Mail to XXX" 1000000 38600 1 2 0 // // @ 
  
-====Delete_alert_template====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf.2011-10-25 --create_alert_template 'template name' "[email protected]@[email protected]" 09:00 18:00 "Email will be sended when the value is in the interval 3-5, between 9AM and 6PM, and only the Mondays. Separator is forced to @" "Unknown" "[email protected]" "subject" "message" 3 "Mail to XXX" 1000000 38600 1 2 0 // // @ 
 + 
 +=== Delete_alert_template ===
 (>=5.0) (>=5.0)
  
Line 834: Line 918:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_alert_template 'Template name' 
  
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_alert_template 'Template name'
  
-====Update_alert_template====+ 
 +=== Update_alert_template ===
 (>=5.0) (>=5.0)
  
Line 845: Line 930:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_alert_template 'Template name' priority 4 
  
-====Get_alert_actions====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_alert_template 'Template name' priority 4 
 + 
 +=== Get_alert_actions ===
 (>=5.0) (>=5.0)
  
-**Parameters:** [[<action_name>|<separator> <return_type>]]+**Parameters:** [<action_name> <separator> <return_type>
  
 **Description:**Returns all action alerts. Optionally you can filter the result by name. Optionally in the second parameter you can specify the separator of the results and in the third parameter the format of the returned list (csv, json, string). **Description:**Returns all action alerts. Optionally you can filter the result by name. Optionally in the second parameter you can specify the separator of the results and in the third parameter the format of the returned list (csv, json, string).
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_alert_actions 'Action 1' ';' 'json' 
  
-====Get_alert_actions_meta====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_alert_actions 'Action 1' ';' 'json' 
 + 
 +=== Get_alert_actions_meta ===
 (>=5.0) (>=5.0)
-{{metaconsole}} 
  
 +<WRAP center round box>This feature is in Metaconsole.</WRAP>
  
-**Parameters:** [[<server_name>|<action_name> <separator> <return_type>]]+ 
 +**Parameters:** [<server_name> <action_name> <separator> <return_type>
  
 **Description:** returns all alert actions of the meta console. Optionally you can filter the result by the name of the node or by the name of the action. Optionally in the second parameter you can specify the results separator and in the third parameter the format of the returned list (csv, json, string).  **Description:** returns all alert actions of the meta console. Optionally you can filter the result by the name of the node or by the name of the action. Optionally in the second parameter you can specify the results separator and in the third parameter the format of the returned list (csv, json, string). 
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_alert_actions_meta // 'Action 1' ';' 'json' 
  
-====Create_alert_command====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_alert_actions_meta // 'Action 1' ';' 'json' 
 + 
 +=== Create_alert_command ===
 (>=5.0) (>=5.0)
  
  
-**Parameters:** <name> <command> [[<group|name> <description> <internal> <field_description> <field_value>]]+**Parameters:** <name> <command> [<group|name> <description> <internal> <field_description> <field_value>]
  
 **Description:** A command will be created with the specified name and command data. Optionally you can specify: **Description:** A command will be created with the specified name and command data. Optionally you can specify:
-<ul> + 
-<li>Group name. If no group is provided, it will be assigned in the group 'All'</li> +  Group name. If no group is provided, it will be assigned in the group 'All'.  
-<li>Command Description.</li> +  Command Description. 
-<li>Internal (1-0).</li> +  Internal (1-0). 
-<li>Field description. This will be formatted as follows: '[["descr1","descr2","descr3","descr4","descr5"]]'.</li> +  Field description. This will be formatted as follows: '["descr1","descr2","descr3","descr4","descr5"]'
-<li>Field value: This will be formatted as follows: [["val1","val2","val3","val4","val5"]].</li> +  Field value: This will be formatted as follows:  ["val1","val2","val3","val4","val5"]. 
-</ul>+
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf  --create_alert_command 'PRUEBA' 'command' 'All' 'Desc' '1' '[["des1","des2","des3","","des5","","","","",""]]' '[["val1","val2","val3","val4","","","","","",""]]' 
  
-====Get_alert_commands====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf  --create_alert_command 'PRUEBA' 'command' 'All' 'Desc' '1' '["des1","des2","des3","","des5","","","","",""]' '["val1","val2","val3","val4","","","","","",""]' 
 + 
 +=== Get_alert_commands ===
 (>=5.0) (>=5.0)
  
-**Parameters:** [[<name>|<command> <group name> <description> <internal>]]+**Parameters:** [<name|<command> <group name> <description> <internal>]
  
 **Description:** Allows you to view all alerts. Optionally you can filter the result by: name, command, group, description or if it is internal (1-0). In the case of the name, command and description it is not necessary to enter the exact data. **Description:** Allows you to view all alerts. Optionally you can filter the result by: name, command, group, description or if it is internal (1-0). In the case of the name, command and description it is not necessary to enter the exact data.
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf  --get_alert_commands "command_name" 
  
-====Validate_all_alerts====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf  --get_alert_commands "command_name" 
 + 
 +=== Validate_all_alerts ===
 (>=5.0) (>=5.0)
  
Line 905: Line 996:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_all_alerts 
  
-====Create_special_day====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_all_alerts 
 + 
 +=== Create_special_day ===
 (>=5.1) (>=5.1)
  
Line 915: Line 1007:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_special_day 2014-05-03 sunday Desc All 
  
-====Delete_special_day====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_special_day 2014-05-03 sunday Desc All 
 + 
 +=== Delete_special_day ===
 (>=5.1) (>=5.1)
  
Line 925: Line 1018:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_special_day 2014-05-03 
  
-====Update_special_day====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_special_day 2014-05-03 
 + 
 +=== Update_special_day ===
 (>=5.1) (>=5.1)
  
Line 936: Line 1030:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_special_day 2014-05-03 same_day monday 
  
-=====Users===== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_special_day 2014-05-03 same_day monday 
-====Create_user==== + 
-**Parameters:** <user_name> <password> <es_admin> [[<comments>]]+==== Users ==== 
 +=== Create_user === 
 +**Parameters:** <user_name> <password> <es_admin> [<comments]
  
 **Description:** It'll be created an user with the name and password that are received as parameters.It will be received also a binary value that specify if the user will be or will be not the administrator. Optionally, it could be also sent comments about the created user. **Description:** It'll be created an user with the name and password that are received as parameters.It will be received also a binary value that specify if the user will be or will be not the administrator. Optionally, it could be also sent comments about the created user.
Line 946: Line 1041:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_user user002 'renardo' 0 'This user has renardo as password' 
  
-====Delete_user====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_user user002 'renardo' 0 'This user has renardo as password' 
 + 
 +=== Delete_user ===
 **Parameters:** <user_name> **Parameters:** <user_name>
  
Line 954: Line 1050:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_user user002 
  
-====Update_user====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_user user002 
 + 
 +=== Update_user ===
 (>=5.0) (>=5.0)
  
Line 964: Line 1061:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_user 'User Id' password 'New password' 
  
-====Enable_user====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_user 'User Id' password 'New password' 
 + 
 +=== Enable_user ===
 (>=5.0) (>=5.0)
  
Line 974: Line 1072:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_user 'User id' 
  
-====Disable_user====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_user 'User id' 
 + 
 +=== Disable_user ===
 (>=5.0) (>=5.0)
  
Line 984: Line 1083:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_user 'User id' 
  
-====Meta_synch_user====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_user 'User id' 
 + 
 +=== Meta_synch_user ===
 (>=5.0)  (>=5.0) 
-{{metaconsole}}+<WRAP center round box>This feature is in Metaconsole.</WRAP>
  
-**Parameters:** <user_name_1,user_name_2,..user_name_n> <server_name> [[<profile_mode>|<group_name> <profile_1,profile_2..,profile2> <create_groups>]]+**Parameters:** <user_name_1,user_name_2,..user_name_n> <server_name> [<profile_mode> <group_name> <profile_1,profile_2..,profile2> <create_groups>]
  
 **Description:** Synchronizes one or more users from the Metaconsole to the node. The first parameter will specify the users we want to synchronize separated by commas. The second parameter will specify the name of the node to which we want to synchronize. Optionally you can specify: **Description:** Synchronizes one or more users from the Metaconsole to the node. The first parameter will specify the users we want to synchronize separated by commas. The second parameter will specify the name of the node to which we want to synchronize. Optionally you can specify:
-<ul> + 
-<li> If it is wanted to copy the original profile or profiles of the user or users (0), or another profile and new group that we will indicate in the following parameters(1). By default it will be 0</li> +  *  If it is wanted to copy the original profile or profiles of the user or users (0), or another profile and new group that we will indicate in the following parameters(1). By default it will be 0 
-<li> Name of the group. The 'All' group will be specified if you want the user to be valid in all groups..</li> +  *  Name of the group. The 'All' group will be specified if you want the user to be valid in all groups.. 
-<li> The profiles you want to assign separated by comma.</li> +  *  The profiles you want to assign separated by comma. 
-<li> In case the group does not exist in the indicated node, the one of the meta console (1) will be copied, otherwise (0) it will be left empty. By default it will be 0 </li> +  *  In case the group does not exist in the indicated node, the one of the meta console (1) will be copied, otherwise (0) it will be left empty. By default it will be 0  
-</ul>+
  
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_synch_user "usuario1,usuario2" "nodo1" "1" "All" "Chief operator,Group coordinator" "0" 
  
-====Create_profile==== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_synch_user "usuario1,usuario2" "nodo1" "1" "All" "Chief operator,Group coordinator" "0" 
-**Parameters:** <profile_name> <incident_view> <incident_edit> <incident_management> <agent_view> + 
-    <agent_edit> <agent_disable> <alert_edit> <alert_management> <user_management> <db_management> +=== Create_profile === 
-    <event_view> <event_edit> <event_management> <report_view> <report_edit> <report_management> +**Parameters:** <profile_name> <incident_view> <incident_edit> <incident_management> <agent_view> <agent_edit> <agent_disable> <alert_edit> <alert_management> <user_management> <db_management> <event_view> <event_edit> <event_management> <report_view> <report_edit> <report_management> <map_view> <map_edit> <map_management> <vconsole_view> <vconsole_edit> <vconsole_management> <pandora_management>
-    <map_view> <map_edit> <map_management> <vconsole_view> <vconsole_edit> <vconsole_management> +
-    <pandora_management>+
  
 **Description:** A new profile will be created, receiving the profile name and permissions as parameters. All fields are mandatory. **Description:** A new profile will be created, receiving the profile name and permissions as parameters. All fields are mandatory.
Line 1015: Line 1112:
 **Example:** **Example:**
  
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_profile 'newProfile' 1 0 1 1 0 0 0 1 1 1 1 1 1 0 0 1 0 0 0 1 1 1 1+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_profile 'newProfile' 1 0 1 1 0 0 0 1 1 1 1 1 1 0 0 1 0 0 0 1 1 1 1
  
-====Update_profile==== +=== Update_profile === 
-**Parameters:** <profile_name> <incident_view> <incident_edit> <incident_management> <agent_view> +**Parameters:** <profile_name> <incident_view> <incident_edit> <incident_management> <agent_view> <agent_edit> <agent_disable> <alert_edit> <alert_management> <user_management> <db_management> <event_view> <event_edit> <event_management> <report_view> <report_edit> <report_management> <map_view> <map_edit> <map_management> <vconsole_view> <vconsole_edit> <vconsole_management> <pandora_management> 
-    <agent_edit> <agent_disable> <alert_edit> <alert_management> <user_management> <db_management> +
-    <event_view> <event_edit> <event_management> <report_view> <report_edit> <report_management> +
-    <map_view> <map_edit> <map_management> <vconsole_view> <vconsole_edit> <vconsole_management> +
-    <pandora_management>+
  
 **Description:** A profile will be updated, receiving the profile name and permissions as parameters. All fields are mandatory. **Description:** A profile will be updated, receiving the profile name and permissions as parameters. All fields are mandatory.
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_profile 'existingProfile' 1 0 1 1 0 0 0 1 1 1 1 1 1 0 0 1 0 0 0 1 1 1 1 
  
-====add_profile====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_profile 'existingProfile' 1 0 1 1 0 0 0 1 1 1 1 1 1 0 0 1 0 0 0 1 1 1 1 
 + 
 +=== add_profile ===
 **Parameters:** <user_name> <profile_name> <group> **Parameters:** <user_name> <profile_name> <group>
  
Line 1035: Line 1129:
  
 **Example:** **Example:**
 + 
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_profile usuario002 'Group coordinator' All
  
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_profile usuario002 'Group coordinator' All 
  
- +=== Delete_profile ===
-====Delete_profile====+
 **Parameters:** <user_name> <profile_name> <group> **Parameters:** <user_name> <profile_name> <group>
  
Line 1045: Line 1139:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_profile usuario002 'Chief Operator' Applications 
  
-====Add_profile_to_user====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_profile usuario002 'Chief Operator' Applications 
 + 
 +=== Add_profile_to_user ===
 (>=5.0) (>=5.0)
  
-**Parameters:** <id_user> <profile_name> [[<group_name>]]+**Parameters:** <id_user> <profile_name> [<group_name]
  
 **Description:** A profile in a group to a user will be assigned. If the group is not provided, the grupo will be 'All'. **Description:** A profile in a group to a user will be assigned. If the group is not provided, the grupo will be 'All'.
    
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_user 'User Id' 'Chief Operator' 'Network' 
  
-====Disable_aecl====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_user 'User Id' 'Chief Operator' 'Network' 
 + 
 +=== Disable_aecl ===
 **Parameters:** No **Parameters:** No
  
Line 1063: Line 1159:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_eacl 
  
-====Enable_aecl====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_eacl 
 + 
 +=== Enable_aecl ===
 **Parameters:** No **Parameters:** No
  
Line 1071: Line 1168:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_eacl 
  
-====Disable_double_auth====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_eacl 
 + 
 +=== Disable_double_auth ===
 **Parameters:** <id_user> **Parameters:** <id_user>
  
Line 1079: Line 1177:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_double_auth 'admin' 
  
-=====Events===== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_double_auth 'admin' 
-====Create_event==== + 
-**Parameters:** <event_name> <event_type> <group_name> [[<agent_name>|<module_name> <event_state> <severity> <template_name> <user_name> <comment> <source> <id_extra> <tags> <custom_data> <force_create_agent> <critical_instructions> <warning_instructions> <unknown_instructions>]] <use_agent_alias>+==== Events ==== 
 +=== Create_event === 
 +**Parameters:** <event_name> <event_type> <group_name> [<agent_name> <module_name> <event_state> <severity> <template_name> <user_name> <comment> <source> <id_extra> <tags> <custom_data> <force_create_agent> <critical_instructions> <warning_instructions> <unknown_instructions>] <use_agent_alias>
  
 **Description:** An event will be created with these data: the name and kind of the event, name of the module, agent and group associated. Optionally it could be sent: **Description:** An event will be created with these data: the name and kind of the event, name of the module, agent and group associated. Optionally it could be sent:
-<ul>  +  
-<li>agent name</li> +  agent name 
-<li>module name</li> +  module name 
-<li>event state (0 if it isn't validated and 1 if it is)</li> +  event state (0 if it isn't validated and 1 if it is) 
-<li>severity (from 1 to 4)</li> +  severity (from 1 to 4) 
-<li>severity: 0 (Maintenance), 1 (Informational), 2 (Normal), 3 (Warning), 4 (Critical).<br>+  severity: 0 (Maintenance), 1 (Informational), 2 (Normal), 3 (Warning), 4 (Critical).
 From version 5.0 there are 5 (Minor) y 6 (Major) too. From version 5.0 there are 5 (Minor) y 6 (Major) too.
-</li> +  * template name in the case that is would be associated to one alert. 
-<li>template name in the case that is would be associated to one alert.</li> +  user name 
-<li>user name</li> +  comment 
-<li>comment</li> +  source 
-<li>source</li> +  Extra id 
-<li>Extra id</li> +  tags: Format should be <tag> <url>,<tag> <url>
-<li>tags: Format should be <tag> <url>,<tag> <url><br>+
 You can add multiple tags separated by commas You can add multiple tags separated by commas
-</li> + 
-<li>custom data: Custom data should be entered as a JSON document. For example: '{"Location": "Office", "Priority": 42}'</li> +  custom data: Custom data should be entered as a JSON document. For example: '{"Location": "Office", "Priority": 42}' 
-<li>Force creation of agent (bool): If the agent name parameter refers to an agent that does not exist, it will be created.</li> +  Force creation of agent (bool): If the agent name parameter refers to an agent that does not exist, it will be created. 
-<li>Critical instructions: Add the instructions to be performed in the case of a critical condition</li> +  Critical instructions: Add the instructions to be performed in the case of a critical condition 
-<li>Warning instructions: Add the instructions to be performed in the case of a warning condition</li> +  Warning instructions: Add the instructions to be performed in the case of a warning condition 
-<li>Unknown instructions: Add the instructions to perform in case of going to unknown state</li> +  Unknown instructions: Add the instructions to perform in case of going to unknown state 
-</ul>+
  
 Nota: Event type could be: unknown, alert_fired, alert_recovered, alert_ceased, alert_manual_validation, recon_host_detected, system, error, new_agent, going_up_warning, going_up_criticalgoing_down_warning, going_down_normal, going_down_critical, going_up_normal, configuration_change. Nota: Event type could be: unknown, alert_fired, alert_recovered, alert_ceased, alert_manual_validation, recon_host_detected, system, error, new_agent, going_up_warning, going_up_criticalgoing_down_warning, going_down_normal, going_down_critical, going_up_normal, configuration_change.
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_event ' CLI Event' system Firewalls 'My agent' 'My module' 0 4 Template004 
  
-====Validate_event====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_event ' CLI Event' system Firewalls 'My agent' 'My module' 0 4 Template004 
 + 
 +=== Validate_event ===
 **Parameters:** <agent_name> <module_name> <datehour_min> <datehour_max> <name_user> <criticity> <template_name> <use_agent_alias> **Parameters:** <agent_name> <module_name> <datehour_min> <datehour_max> <name_user> <criticity> <template_name> <use_agent_alias>
  
Line 1120: Line 1219:
  
  
-It's possible to combine the parameters in several ways, leaving blank with empty inverted commas (<nowiki>//</nowiki>) the ones that you don't want to use and filling in the rest.+It's possible to combine the parameters in several ways, leaving blank with empty inverted commas (//) the ones that you don't want to use and filling in the rest.
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_event 'My agent' 'My module' <nowiki>//</nowiki> '2010-06-02 22:02'+ 
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_event 'My agent' 'My module' // '2010-06-02 22:02'
  
 In this example will be validated all the events associated to the module 'Mi module' of the agent 'My agent' which data would be previous to 2 june 2010 not considering the rest of the filters. It would be also possible to filter the events between two dates filling both of them or the ones that have a data higher to an specific one, filling in only the date-hour minimum. In this example will be validated all the events associated to the module 'Mi module' of the agent 'My agent' which data would be previous to 2 june 2010 not considering the rest of the filters. It would be also possible to filter the events between two dates filling both of them or the ones that have a data higher to an specific one, filling in only the date-hour minimum.
  
-====Validate_event_id====+=== Validate_event_id ===
 (>=5.0) (>=5.0)
  
Line 1135: Line 1235:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_event_id 1894+ 
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_event_id 1894
  
 In this example, will be validated the event whose identifier is 1894. In this example, will be validated the event whose identifier is 1894.
  
-====Get_event_info====+=== Get_event_info ===
 (>=5.0) (>=5.0)
  
-**Parameters:** <id_event>[[<separator>]]+**Parameters:** <id_event>[<separator]
  
 **Description:** Display info about a event given a id. **Description:** Display info about a event given a id.
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_event_info 1894+ 
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_event_info 1894
  
 In this example, will be displayed info about the event whose identifier is 1894. The fields will be separated by | In this example, will be displayed info about the event whose identifier is 1894. The fields will be separated by |
  
-====Add_event_comment====+=== Add_event_comment ===
 (>=5.1) (>=5.1)
  
Line 1159: Line 1261:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_event_comment 1234 admin TEXT+ 
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_event_comment 1234 admin TEXT
  
 In this example, comment 'TEXT' by 'admin' will be added to the event whose identifier is 1234. In this example, comment 'TEXT' by 'admin' will be added to the event whose identifier is 1234.
  
-=====Incidents===== +==== Incidents ==== 
-====Create_incident====+=== Create_incident ===
 (>=5.0) (>=5.0)
  
-**Parameters:** <title> <description> <origin> <status> <priority> <group> [[<owner>]]+**Parameters:** <title> <description> <origin> <status> <priority> <group> [<owner]
  
 **Description:** An incident will be created passing the title, the description, the origin, the status, the priority, the group and optionally the owner to it. **Description:** An incident will be created passing the title, the description, the origin, the status, the priority, the group and optionally the owner to it.
Line 1180: Line 1283:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_incident 'Incident' 'Incident Description' 'Other data source' 3 2 'id_owner_user' 
  
-=====Policies===== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_incident 'Incident' 'Incident Description' 'Other data source' 3 2 'id_owner_user' 
-====Create_policy====+ 
 +==== Policies ==== 
 +=== Create_policy ===
 **Parameters:** <policy_name> <group> <description> **Parameters:** <policy_name> <group> <description>
  
Line 1189: Line 1293:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy 'My policy' 'My group' 'Description' 
  
-====Apply_policy====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy 'My policy' 'My group' 'Description' 
 + 
 +=== Apply_policy ===
 **Parameters:** <policy_name> **Parameters:** <policy_name>
  
Line 1198: Line 1303:
 As this command works through the API, it needs the following parameters:  As this command works through the API, it needs the following parameters: 
  
-*id=&lt;id_policy&gt; (required) +  * id =<id_policy(required) 
-*id2=&lt;id_agent&gt; (optional) Id or name of the agent as indicated in the other parameter. If it is empty, the policy will be applied to all the agents of this.  +  * id2=<id_agent(optional) Id or name of the agent as indicated in the other parameter. If it is empty, the policy will be applied to all the agents of this.  
-*other=&lt;serialized parameters&gt;  +  * other =<serialized parameters 
-:*&lt;name_agent (Boolean)&gt; Indicates if the agent will be sent by Id (0) or by name (1). +    <name_agent (Boolean)Indicates if the agent will be sent by Id (0) or by name (1). 
-:*&lt;server_id&gt; (required if using Metaconsole) Id of the server in which the policy will be applied.+    <server_id(required if using Metaconsole) Id of the server in which the policy will be applied.
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --apply_policy 'policy_id' 'agent_id' 'other1|other2' 
  
-====Apply_all_policies====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --apply_policy 'policy_id' 'agent_id' 'other1|other2' 
 + 
 +=== Apply_all_policies ===
 (>=5.0) (>=5.0)
  
Line 1215: Line 1321:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --apply_all_policies 
  
-====Add_agent_to_policy====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --apply_all_policies 
 + 
 +=== Add_agent_to_policy ===
 (>=5.0) (>=5.0)
  
Line 1225: Line 1332:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_agent_to_policy 'Agent name' 'Policy name' 
  
-====Add_collection_to_policy====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_agent_to_policy 'Agent name' 'Policy name' 
 + 
 +=== Add_collection_to_policy ===
 **Parameters:** <policy_name> <collection_name> **Parameters:** <policy_name> <collection_name>
  
Line 1233: Line 1341:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_collection_to_policy 'Policy name' 'Collection name' 
  
-====Create policy data module from local component====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_collection_to_policy 'Policy name' 'Collection name' 
 + 
 +=== Create policy data module from local component ===
 **Parameters:** <policy_name> <component_name> **Parameters:** <policy_name> <component_name>
  
Line 1241: Line 1350:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_data_module_from_local_component 'Policy name' 'Component name' 
  
-====Delete_not_policy_modules====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_data_module_from_local_component 'Policy name' 'Component name' 
 + 
 +=== Delete_not_policy_modules ===
 **Parameters:** Not **Parameters:** Not
  
Line 1249: Line 1359:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_nor_policy_modules 
  
-====Remove_agent_from_policy====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_nor_policy_modules 
 + 
 +=== Remove_agent_from_policy ===
 **Parameters:** <id_policy> <id_agent> **Parameters:** <id_policy> <id_agent>
  
Line 1257: Line 1368:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --remove_agent_from_policy '11' '2' 
  
-====Disable_policy_alerts====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --remove_agent_from_policy '11' '2' 
 + 
 +=== Disable_policy_alerts ===
 **Parameters:** <policy_name> **Parameters:** <policy_name>
  
Line 1265: Line 1377:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_policy_alerts 'My policy' 
  
-====Create_policy_data_module====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_policy_alerts 'My policy' 
 + 
 +=== Create_policy_data_module ===
 (>=5.0) (>=5.0)
  
-**Parameters:** <policy_name> <module_name> <module_type> [[<description>|<module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <data_configuration> <warning_str> <critical_str> <enable_unknown_events> <ff_threshold> <each_ff> <ff_threshold_normal> <ff_threshold_warning> <ff_threshold_critical> <ff_timeout> <critical_instructions> <warning_instructions> <unknown_instructions>+**Parameters:** <policy_name> <module_name> <module_type> [<description> <module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <data_configuration> <warning_str> <critical_str> <enable_unknown_events> <ff_threshold> <each_ff> <ff_threshold_normal> <ff_threshold_warning> <ff_threshold_critical> <ff_timeout> <critical_instructions> <warning_instructions> <unknown_instructions>
  
 **Description:** A policy data module will be created. The default values are the same of --create_data_module option **Description:** A policy data module will be created. The default values are the same of --create_data_module option
Line 1285: Line 1398:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_data_module 'policy name' 'module name' generic_proc 'module description' 'group name' 0 100 0 300 30 60 61 100 0 "module_begin\nmodule_name modname\nmodule_end" 'string for warning' 'string for critical' 
  
-====Create_policy_web_module====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_data_module 'policy name' 'module name' generic_proc 'module description' 'group name' 0 100 0 300 30 60 61 100 0 "module_begin\nmodule_name modname\nmodule_end" 'string for warning' 'string for critical' 
 + 
 +=== Create_policy_web_module ===
 (>=7.0) (>=7.0)
  
-**Parameters:** <policy_name> <module_name> <module_type> [<description> <module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <retries> <requests> <agent_browser_id> <auth_server> <auth_realm> <configuration_data> <proxy_url> <proxy_auth_login> <proxy_auth_password> <warning_str> <critical_str> <enable_unknown_events> <ff_threshold> <each_ff> <ff_threshold_normal> <ff_threshold_warning> <ff_threshold_critical> <ff_timeout> <warning_inverse> <critical_inverse> <critical_instructions> <warning_instructions> <unknown_instructions>]]+**Parameters:** <policy_name> <module_name> <module_type> [<description> <module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <retries> <requests> <agent_browser_id> <auth_server> <auth_realm> <configuration_data> <proxy_url> <proxy_auth_login> <proxy_auth_password> <warning_str> <critical_str> <enable_unknown_events> <ff_threshold> <each_ff> <ff_threshold_normal> <ff_threshold_warning> <ff_threshold_critical> <ff_timeout> <warning_inverse> <critical_inverse> <critical_instructions> <warning_instructions> <unknown_instructions>]
  
 **Description:** A policy web module will be created. The default values are the same of --create_web_module option **Description:** A policy web module will be created. The default values are the same of --create_web_module option
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_web_module 'policy_name' 'module_name' web_data 'module_description' 'General' 0 100 0 300 0 0 0 0 1 0 1 'Pandora FMS' auto public "module_begin\nmodule_name modname\nmodule_end" '<nowiki>http://proxy.url</nowiki>' 'proxy_login' 'proxy_password' 1 10 10 10 10 10 10 10 10 1 1 'critical_instructions' 'warninng_instructions' 'unknown_instructions' 
  
-====Create_policy_network_module====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_web_module 'policy_name' 'module_name' web_data 'module_description' 'General' 0 100 0 300 0 0 0 0 1 0 1 'Pandora FMS' auto public "module_begin\nmodule_name modname\nmodule_end" 'http://proxy.url' 'proxy_login' 'proxy_password' 1 10 10 10 10 10 10 10 10 1 1 'critical_instructions' 'warninng_instructions' 'unknown_instructions' 
 + 
 +=== Create_policy_network_module ===
 (>=5.0) (>=5.0)
  
-**Parameters:** <policy_name> <module_name> <module_type> [[<module_port>|<description> <module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <ff_threshold> <warning_str> <critical_str> <enable_unknown_events> <each_ff> <ff_threshold_normal> <ff_threshold_warning> <ff_threshold_critical> <critical_instructions> <warning_instructions> <unknown_instructions>]]+**Parameters:** <policy_name> <module_name> <module_type> [<module_port> <description> <module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <ff_threshold> <warning_str> <critical_str> <enable_unknown_events> <each_ff> <ff_threshold_normal> <ff_threshold_warning> <ff_threshold_critical> <critical_instructions> <warning_instructions> <unknown_instructions>]
  
 **Description:** A policy network module will be created. The default values are the same of --create_network_module option **Description:** A policy network module will be created. The default values are the same of --create_network_module option
Line 1313: Line 1428:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_network_module 'policy name' 'module name' remote_icmp_proc 22 'module description' 'group name' 0 100 0 300 30 60 61 100 0 0 'string for warning' 'string for critical' 
  
-====Create_policy_snmp_module====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_network_module 'policy name' 'module name' remote_icmp_proc 22 'module description' 'group name' 0 100 0 300 30 60 61 100 0 0 'string for warning' 'string for critical' 
 + 
 +=== Create_policy_snmp_module ===
 (>=5.0) (>=5.0)
  
-**Parameters:** <policy_name> <module_name> <module_type> <module_port> <version> [[<community>|<oid> <description> <module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <snmp3_priv_method> <snmp3_priv_pass> <snmp3_sec_level> <snmp3_auth_method> <snmp3_auth_user> <snmp3_priv_pass> <ff_threshold> <warning_str> <critical_str> <enable_unknown_events> <each_ff> <ff_threshold_normal> <ff_threshold_warning> <ff_threshold_critical> <critical_instructions> <warning_instructions> <unknown_instructions>]]+**Parameters:** <policy_name> <module_name> <module_type> <module_port> <version> [<community> <oid> <description> <module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <snmp3_priv_method> <snmp3_priv_pass> <snmp3_sec_level> <snmp3_auth_method> <snmp3_auth_user> <snmp3_priv_pass> <ff_threshold> <warning_str> <critical_str> <enable_unknown_events> <each_ff> <ff_threshold_normal> <ff_threshold_warning> <ff_threshold_critical> <critical_instructions> <warning_instructions> <unknown_instructions>]
  
 **Description:** A policy SNMP module will be created. The default values are the same of --create_snmp_module option **Description:** A policy SNMP module will be created. The default values are the same of --create_snmp_module option
Line 1331: Line 1447:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_snmp_module 'policy name' 'module name' remote_snmp_inc 8080 1 mycommunity myoid 'Module description' 
  
-====Create_policy_plugin_module====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_snmp_module 'policy name' 'module name' remote_snmp_inc 8080 1 mycommunity myoid 'Module description' 
 + 
 +=== Create_policy_plugin_module ===
 (>=5.0) (>=5.0)
  
-**Parameters:** <policy_name> <module_name> <module_kind> <module_port> <plugin_name> <user> <password> <parameters> [[<description>|<module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <warning_str> <critical_str> <enable_unknown_events> <each_ff> <ff_threshold_normal> <ff_threshold_warning> <ff_threshold_critical> <critical_instructions> <warning_instructions> <unknown_instructions>]]+**Parameters:** <policy_name> <module_name> <module_kind> <module_port> <plugin_name> <user> <password> <parameters> [<description> <module_group> <min> <max> <post_process> <interval> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <warning_str> <critical_str> <enable_unknown_events> <each_ff> <ff_threshold_normal> <ff_threshold_warning> <ff_threshold_critical> <critical_instructions> <warning_instructions> <unknown_instructions>]
  
 **Description:** A policy plugin module will be created. The default values are the same of --create_plugin_module option **Description:** A policy plugin module will be created. The default values are the same of --create_plugin_module option
Line 1343: Line 1460:
  
 The next parameters are only for the Pandora version 5.1 and next versions: The next parameters are only for the Pandora version 5.1 and next versions:
 +
   * <each_ff>   * <each_ff>
   * <ff_threshold_normal>   * <ff_threshold_normal>
Line 1349: Line 1467:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_plugin_module 'policy name' 'module name' generic_data 22 myplugin myuser mypass 'param1 param2 param3' 'Module description' 'General' 1 3 0 300 0 0 0 0 1 'string for warning' 'string for critical' 
  
-====Validate_policy_alerts====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_plugin_module 'policy name' 'module name' generic_data 22 myplugin myuser mypass 'param1 param2 param3' 'Module description' 'General' 1 3 0 300 0 0 0 0 1 'string for warning' 'string for critical' 
 + 
 +=== Validate_policy_alerts ===
 (>=5.0) (>=5.0)
  
Line 1359: Line 1478:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_policy_alerts 'Policy name' 
  
-====Get_policy_modules====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_policy_alerts 'Policy name' 
 + 
 +=== Get_policy_modules ===
 (>=5.0) (>=5.0)
  
Line 1369: Line 1489:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_policy_modules 'Policy name' 
  
-====Get_policies====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_policy_modules 'Policy name' 
 + 
 +=== Get_policies ===
 (>=5.0) (>=5.0)
  
-**Parameters:** [[<agent_name>|<use_agent_alias>]]+**Parameters:** [<agent_name> <use_agent_alias>]
  
 **Description:** Get all the policies (without parameters) or the policies of a given agent (agent name as parameter) **Description:** Get all the policies (without parameters) or the policies of a given agent (agent name as parameter)
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_policies 'Agent name' 
  
-===== Netflow===== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_policies 'Agent name' 
-====Create_netflow_filter====+ 
 +==== Netflow ==== 
 +=== Create_netflow_filter ===
 (>=5.0) (>=5.0)
  
Line 1393: Line 1515:
  
 **Example:** **Example:**
 + 
 To create a netflow filter we execute the following option: To create a netflow filter we execute the following option:
  
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_netflow_filter "Filter name" Network "host 192.168.50.3 OR host 192.168.50.4 or HOST 192.168.50.6" dstport kilobytes+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_netflow_filter "Filter name" Network "host 192.168.50.3 OR host 192.168.50.4 or HOST 192.168.50.6" dstport kilobytes
  
-===== Tools===== +==== Tools ==== 
-====Exec_from_file====+=== Exec_from_file ===
 (>=5.0) (>=5.0)
  
Line 1407: Line 1529:
  
 **Example:** **Example:**
-We are going to create users from a CSV file. + 
 + We are going to create users from a CSV file. 
  
 We need a CSV file like that: We need a CSV file like that:
  
 +<code>
  User 1,Password 1,0  User 1,Password 1,0
  User 2,Password 2,0  User 2,Password 2,0
  User 3,Password 3,0  User 3,Password 3,0
  User Admin,Password Admin,1  User Admin,Password Admin,1
 +</code>
  
 The name of the file will be '/tmp/users_csv' The name of the file will be '/tmp/users_csv'
Line 1422: Line 1547:
 To do this, we execute the following option: To do this, we execute the following option:
  
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --exec_from_file /tmp/users_csv create_user __FIELD1__ __FIELD2__ __FIELD3__ 'User created with exec_from_file option from CLI'+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --exec_from_file /tmp/users_csv create_user __FIELD1__ __FIELD2__ __FIELD3__ 'User created with exec_from_file option from CLI'
  
 NOTE: Commas into the CSV columns are not yet supported NOTE: Commas into the CSV columns are not yet supported
Line 1428: Line 1553:
  
  
-====create_snmp_trap====+=== create_snmp_trap ===
 (>=5.0) (>=5.0)
  
Line 1441: Line 1566:
 **Sample:** **Sample:**
  
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_snmp_trap Cisco_FAN_Crash 1.3.3.3.2.12.3.3.4.1 "Something happen with the FAN inside the CISCO device, probably a failure" 3+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_snmp_trap Cisco_FAN_Crash 1.3.3.3.2.12.3.3.4.1 "Something happen with the FAN inside the CISCO device, probably a failure" 3
  
-=====Graphs===== +==== Graphs ==== 
-====create_custom_graph====+=== create_custom_graph ===
 **Parameters:** <name> <description> <user> <id_group> <width> <height> <events> <graph_type> <period> <modules> <separator> **Parameters:** <name> <description> <user> <id_group> <width> <height> <events> <graph_type> <period> <modules> <separator>
  
Line 1458: Line 1583:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_custom_graph 'My graph' 'Created by CLI' 'admin' 0 <nowiki>'</nowiki><nowiki>'</nowiki> <nowiki>'</nowiki><nowiki>'</nowiki> 0 2 <nowiki>'</nowiki><nowiki>'</nowiki> '1;2;5;30' ';' 
  
-====edit_custom_graph====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_custom_graph 'My graph' 'Created by CLI' 'admin' 0 '' '' 0 2 '' '1;2;5;30' ';' 
 + 
 +=== edit_custom_graph ===
 **Parameters:** <id_graph> <name> <description> <user> <id_group> <width> <height> <events> <graph_type> <period> **Parameters:** <id_graph> <name> <description> <user> <id_group> <width> <height> <events> <graph_type> <period>
  
Line 1467: Line 1593:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --edit_custom_graph 12 <nowiki>'</nowiki><nowiki>'</nowiki> 'edit graph by CLI' <nowiki>'</nowiki><nowiki>'</nowiki> <nowiki>'</nowiki><nowiki>'</nowiki> <nowiki>'</nowiki><nowiki>'</nowiki> <nowiki>'</nowiki><nowiki>'</nowiki> <nowiki>'</nowiki><nowiki>'</nowiki> <nowiki>'</nowiki><nowiki>'</nowiki> 25200 
  
-====add_modules_to_graph====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --edit_custom_graph 12 '' 'edit graph by CLI' '' '' '' '' '' '' 25200 
 + 
 +=== add_modules_to_graph ===
 **Parameters:** <id_graph> <modules> <separator> **Parameters:** <id_graph> <modules> <separator>
  
Line 1477: Line 1604:
 **Example:** **Example:**
  
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_modules_to_graph 12 '25,26' ','+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_modules_to_graph 12 '25,26' ','
  
-====delete_modules_to_graph====+=== delete_modules_to_graph ===
 **Parameters:** <id_graph> <modules> <separator> **Parameters:** <id_graph> <modules> <separator>
  
Line 1487: Line 1614:
 **Example:** **Example:**
  
 + 
  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_modules_to_graph 12 '1,25,26' ','  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_modules_to_graph 12 '1,25,26' ','
  
-=====Clusters===== +==== Clusters ==== 
-====new_cluster====+=== new_cluster ===
 **Parameters:** <cluster_name> <cluster_type> <description> <group_id> **Parameters:** <cluster_name> <cluster_type> <description> <group_id>
  
Line 1496: Line 1624:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --new_cluster cluster1 AA description 12 
  
-====add_cluster_agent==== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --new_cluster cluster1 AA description 12 
-**Parameters:** <json_data_base64:[[{"id":5,"id_agent":2},{"id":5,"id_agent":3}]]>+ 
 +=== add_cluster_agent === 
 +**Parameters:** <json_data_base64:[{"id":5,"id_agent":2},{"id":5,"id_agent":3}]>
  
 **Description:** A specific agent will be added to the specified cluster. It is absolutely necessary that JSONs are encoded on base 64. **Description:** A specific agent will be added to the specified cluster. It is absolutely necessary that JSONs are encoded on base 64.
  
 **Example :** **Example :**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_cluster_agent W3siaWQiOjUsImlkX2FnZW50IjoyfSwKeyJpZCI6NSwiaWRfYWdlbnQiOjN9XQ==+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_cluster_agent W3siaWQiOjUsImlkX2FnZW50IjoyfSwKeyJpZCI6NSwiaWRfYWdlbnQiOjN9XQ ===
  
-====add_cluster_item (active / active)==== +=== add_cluster_item (active / active)==== 
-**Parameters:** <json_data_base64:[[{"name":"Swap_Used","id_cluster":5,"type":"AA","critical_limit":80,"warning_limit":60},|{"name":"TCP_Connections","id_cluster":5,"type":"AA","critical_limit":80,"warning_limit":60}]]>+ 
 +**Parameters:** <json_data_base64:[{"name":"Swap_Used","id_cluster":5,"type":"AA","critical_limit":80,"warning_limit":60}, {"name":"TCP_Connections","id_cluster":5,"type":"AA","critical_limit":80,"warning_limit":60}]> 
  
 **Description:** A specific module will be added as an item to the specified cluster. It is absolutely necessary that JSONs are encoded on base 64. **Description:** A specific module will be added as an item to the specified cluster. It is absolutely necessary that JSONs are encoded on base 64.
  
 **Example :** **Example :**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_cluster_agent W3sibmFtZSI6IlN3YXBfVXNlZCIsImlkX2NsdXN0ZXIiOjUsInR5cGUiOiJBQSIsImNyaXRpY2FsX2xpbWl0Ijo4MCwid2FybmluZ19saW1pdCI6NjB9LAp7Im5hbWUiOiJUQ1BfQ29ubmVjdGlvbnMiLCJpZF9jbHVzdGVyIjo1LCJ0eXBlIjoiQUEiLCJjcml0aWNhbF9saW1pdCI6ODAsIndhcm5pbmdfbGltaXQiOjYwfV0= 
  
-====add_cluster_item (active / pasive)==== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_cluster_agent W3sibmFtZSI6IlN3YXBfVXNlZCIsImlkX2NsdXN0ZXIiOjUsInR5cGUiOiJBQSIsImNyaXRpY2FsX2xpbWl0Ijo4MCwid2FybmluZ19saW1pdCI6NjB9LAp7Im5hbWUiOiJUQ1BfQ29ubmVjdGlvbnMiLCJpZF9jbHVzdGVyIjo1LCJ0eXBlIjoiQUEiLCJjcml0aWNhbF9saW1pdCI6ODAsIndhcm5pbmdfbGltaXQiOjYwfV0= 
-**Parameters:** <json_data_base64:[[{"name":"DiskUsed_/proc/kcore","id_cluster":5,"type":"AP","is_critical":1},|{"name":"DiskUsed_/proc/sched_debug","id_cluster":5,"type":"AP","is_critical":1}]]>+ 
 +=== add_cluster_item (active / pasive) === 
 + 
 +**Parameters:** <json_data_base64:[{"name":"DiskUsed_/proc/kcore","id_cluster":5,"type":"AP","is_critical":1}, {"name":"DiskUsed_/proc/sched_debug","id_cluster":5,"type":"AP","is_critical":1}]> 
  
 **Description:** A specific module will be added as an item to the specified cluster. It is absolutely necessary that JSONs are encoded on base 64. **Description:** A specific module will be added as an item to the specified cluster. It is absolutely necessary that JSONs are encoded on base 64.
  
 **Example :** **Example :**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_cluster_agent W3sibmFtZSI6IkRpc2tVc2VkXy9wcm9jL2tjb3JlIiwiaWRfY2x1c3RlciI6NSwidHlwZSI6IkFQIiwiaXNfY3JpdGljYWwiOjF9LAp7Im5hbWUiOiJEaXNrVXNlZF8vcHJvYy9zY2hlZF9kZWJ1ZyIsImlkX2NsdXN0ZXIiOjUsInR5cGUiOiJBUCIsImlzX2NyaXRpY2FsIjoxfV0=+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_cluster_agent W3sibmFtZSI6IkRpc2tVc2VkXy9wcm9jL2tjb3JlIiwiaWRfY2x1c3RlciI6NSwidHlwZSI6IkFQIiwiaXNfY3JpdGljYWwiOjF9LAp7Im5hbWUiOiJEaXNrVXNlZF8vcHJvYy9zY2hlZF9kZWJ1ZyIsImlkX2NsdXN0ZXIiOjUsInR5cGUiOiJBUCIsImlzX2NyaXRpY2FsIjoxfV0=
  
-====delete_cluster====+=== delete_cluster ===
 **Parameters:** <cluster_id> **Parameters:** <cluster_id>
  
Line 1528: Line 1660:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_cluster_item 1 
  
-====delete_cluster_agent====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_cluster_item 1 
 + 
 +=== delete_cluster_agent ===
 **Parameters:** <agent_id> <cluster_id> **Parameters:** <agent_id> <cluster_id>
  
Line 1536: Line 1669:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_cluster_agent 1 1 
  
-====delete_cluster_item====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_cluster_agent 1 1 
 + 
 +=== delete_cluster_item ===
 **Parameters:** <item_id> **Parameters:** <item_id>
  
Line 1544: Line 1678:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_cluster_item 1 
  
-=====Visual Consoles===== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_cluster_item 1 
-====create_visual_console==== + 
-**Parameters:** <name> <background> <width> <height> <group> <mode> [[<position_to_locate_elemens>|<background_color> <elements>]]+==== Visual Consoles ==== 
 +=== create_visual_console === 
 +**Parameters:** <name> <background> <width> <height> <group> <mode> [<position_to_locate_elemens|<background_color> <elements>]]
  
 **Description:** A visual console will be created with the specified parameters and their associated elements. It is absolutely necessary that the JSONs go in single quotes because if they don't, there could be errors in the shell from which the script is launched. **Description:** A visual console will be created with the specified parameters and their associated elements. It is absolutely necessary that the JSONs go in single quotes because if they don't, there could be errors in the shell from which the script is launched.
Line 1555: Line 1690:
  
 **Example (auto_creation):** **Example (auto_creation):**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_visual_console 'test console' 'mapamundo.jpg' 1024 768 12 'auto_creation' '{"pos1x":0,"pos1y":60,"pos2x":800,"pos2y":600}' '#FFF' '[[{"image":|"_engine","height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 1,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"},{"image": "_printer","height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 2,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"}]]'+  
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_visual_console 'test console' 'mapamundo.jpg' 1024 768 12 'auto_creation' '{"pos1x":0,"pos1y":60,"pos2x":800,"pos2y":600}' '#FFF' '[{"image": "_engine","height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 1,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"},{"image": "_printer","height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 2,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"}]'
  
 **Example (static_objects):** **Example (static_objects):**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_visual_console 'test console' 'mapamundo.jpg' 1024 768 12 'static_objects' "" '#FFF' '[[{"image":|"_engine","pos_x":100,"pos_y":100,"height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 1,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"},{"image": "_printer","pos_x":400,"pos_y":100,"height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 2,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"}]]'+ 
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_visual_console 'test console' 'mapamundo.jpg' 1024 768 12 'static_objects' "" '#FFF' '[{"image": "_engine","pos_x":100,"pos_y":100,"height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 1,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"},{"image": "_printer","pos_x":400,"pos_y":100,"height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 2,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"}]'
  
  
-====edit_visual_console==== +=== edit_visual_console === 
-**Parameters:** <id> [[<name>|<background> <width> <height> <group> <mode> <position_to_locate_elemens> <background_color> <elements>]]+**Parameters:** <id> [<name> <background> <width> <height> <group> <mode> <position_to_locate_elemens> <background_color> <elements>]
  
 **Description:** A visual console with the specified parameters and its associated elements will be edited. It is absolutely necessary that the JSONs go between single quotes since if it didn't occur it could cause errors in the shell from where the script is launched. **Description:** A visual console with the specified parameters and its associated elements will be edited. It is absolutely necessary that the JSONs go between single quotes since if it didn't occur it could cause errors in the shell from where the script is launched.
  
 **Example (auto_creation):** **Example (auto_creation):**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --edit_visual_console 1 'test console edited' // // // // 'auto_creation' //{"pos1x":0,"pos1y":60,"pos2x":800,"pos2y":600}// // '[[{"id":103,"image":|"_engine","height": 180,"width": 200,"label": "","type": 0,"period": 300,"id_agent": 3,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"},{"pos_x":400,"pos_y":100,"image": "_printer","height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 4,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"}]]'+ 
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --edit_visual_console 1 'test console edited'     'auto_creation' {"pos1x":0,"pos1y":60,"pos2x":800,"pos2y":600}  '[{"id":103,"image": "_engine","height": 180,"width": 200,"label": "","type": 0,"period": 300,"id_agent": 3,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"},{"pos_x":400,"pos_y":100,"image": "_printer","height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 4,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"}]'
  
 **Example (static_objects):** **Example (static_objects):**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --edit_visual_console 1 'test console edited' // // // // 'static_objects' // // '[[{"id":103,"image":|"_engine","height": 180,"width": 200,"label": "","type": 0,"period": 300,"id_agent": 3,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"},{"pos_x":400,"pos_y":100,"image": "_printer","height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 4,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"}]]' 
  
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --edit_visual_console 1 'test console edited'     'static_objects'   '[{"id":103,"image": "_engine","height": 180,"width": 200,"label": "","type": 0,"period": 300,"id_agent": 3,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"},{"pos_x":400,"pos_y":100,"image": "_printer","height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 4,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"}]'
  
-====delete_visual_console====+ 
 +=== delete_visual_console ===
 **Parameters:** <id>  **Parameters:** <id> 
  
Line 1579: Line 1718:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_visual_console 1+ 
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_visual_console 1
  
  
-====delete_visual_console_objects====+=== delete_visual_console_objects ===
 **Parameters:** <id> <mode> <id_mode> **Parameters:** <id> <mode> <id_mode>
  
Line 1588: Line 1728:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_visual_console_objects 1 'id_agent' 1 
  
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_visual_console_objects 1 'id_agent' 1
  
-====duplicate_visual_console==== + 
-**Parameters:** <id> <times> [[<prefix>]]+=== duplicate_visual_console === 
 +**Parameters:** <id> <times> [<prefix]
  
 **Description:** The indicated visual console will be duplicated as many times as desired. **Description:** The indicated visual console will be duplicated as many times as desired.
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --duplicate_visual_console 1 10 'test console 2' 
  
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --duplicate_visual_console 1 10 'test console 2'
  
-====export_json_visual_console==== + 
-**Parameters:** <id> [[<path>|<with_element_id>]]+=== export_json_visual_console === 
 +**Parameters:** <id> [<path> <with_element_id>]
  
 **Description:** Exports to json a visual console and its elements being able to specify the path where to save the file and if you want to include the id of the associated elements to facilitate a later edition. **Description:** Exports to json a visual console and its elements being able to specify the path where to save the file and if you want to include the id of the associated elements to facilitate a later edition.
  
 **Interesting data:** The field "with_element_id" can return 1 and 0, which mean with or without ID respectively. **Interesting data:** The field "with_element_id" can return 1 and 0, which mean with or without ID respectively.
 +
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --export_json_visual_console 1 '/tmp' 1 
  
-======Others====== +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --export_json_visual_console 1 '/tmp'
-====meta_get_agent_group====+ 
 +==== Others ==== 
 +=== meta_get_agent_group ===
 **Parameters:** <host> <api_pass> <user> <pass> <agent_name> **Parameters:** <host> <api_pass> <user> <pass> <agent_name>
  
Line 1617: Line 1761:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_get_agent_group <nowiki>http://127.0.0.1/pandora_console</nowiki> 1234 admin pandora NAS 
  
-====meta_get_agent_group_id====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_get_agent_group http://127.0.0.1/pandora_console 1234 admin pandora NAS 
 + 
 +=== meta_get_agent_group_id === 
 **Parameters:** <host> <api_pass> <user> <pass> <agent_name> **Parameters:** <host> <api_pass> <user> <pass> <agent_name>
  
Line 1626: Line 1772:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_get_agent_group_id <nowiki>http://127.0.0.1/pandora_console</nowiki> 1234 admin pandora NAS 
  
-====meta_delete_agent====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_get_agent_group_id http://127.0.0.1/pandora_console 1234 admin pandora NAS 
 + 
 +=== meta_delete_agent === 
 **Parameters:** <host> <api_pass> <user> <pass> <agent_name> **Parameters:** <host> <api_pass> <user> <pass> <agent_name>
  
Line 1635: Line 1783:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_delete_agent <nowiki>http://127.0.0.1/pandora_console</nowiki> 1234 admin pandora NAS+ 
 +  perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_delete_agent http://127.0.0.1/pandora_console 1234 admin pandora NAS
  
  
-====locate_agent====+=== locate_agent ===
 **Parameters:** <agent_name> <use_agent_alias> **Parameters:** <agent_name> <use_agent_alias>
  
Line 1645: Line 1794:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --locate_agent NAS 
  
-====meta_set_create_group====+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --locate_agent NAS 
 + 
 +=== meta_set_create_group ===
 **Parameters:** <url_host> <api_pass> <user> <pass> <group_name> (<icon_name> | "<icon_name>|<id_group_parent>") **Parameters:** <url_host> <api_pass> <user> <pass> <group_name> (<icon_name> | "<icon_name>|<id_group_parent>")
  
Line 1654: Line 1804:
  
 **Example:** **Example:**
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_set_create_group <nowiki>http://127.0.0.1/pandora_console</nowiki> 1234 admin pandora salamanca "world|14" 
  
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_set_create_group <nowiki>http://127.0.0.1/pandora_console</nowiki> 1234 admin pandora salamanca world+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_set_create_group http://127.0.0.1/pandora_console 1234 admin pandora salamanca "world|14"
  
-======Help======+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_set_create_group http://127.0.0.1/pandora_console 1234 admin pandora salamanca world 
 + 
 +==== Help ====
 To obtain general help with the Pandora FMS CLI you only need to writte: To obtain general help with the Pandora FMS CLI you only need to writte:
  
- perl pandora_manage.pl --h+  perl pandora_manage.pl --h
  
 To obtain help of one specific option, it would be enough with putting this option without parameters (this for the options that use parameters). To obtain help of one specific option, it would be enough with putting this option without parameters (this for the options that use parameters).
- perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_user 
  
-[[Pandora:Documentation_en|Go back to Pandora FMS documentation index]]+  perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_user 
 + 
 +[[en:documentation:start|Go back to Pandora FMS documentation index]]
  
-[[Category:Pandora FMS]] 
ºº