Table of Contents

Pandora FMS Command Line Interface (CLI)

Go back to Pandora FMS documentation index

We are working on updating the CLI documentation. Sorry for any inconvenience.

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.

Community version:

The CLI is a file in Perl language, to call CLI:

perl pandora_manage.pl <pandora_server.conf path > <option > <option parameters > [ optional parameters ]

With backslash \ as a line connector:

perl pandora_manage.pl \
    <pandora_server.conf path > \
    <option > \
    <option parameters > \
    [ optional parameters ]

Enterprise version:

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.

pandora_manage <pandora_server.conf path> <option> <option parameters>  [ optional parameters ]

With backslash \ as a line connector:

pandora_manage \
    <pandora_server.conf path> \
    <option> \
    <option parameters> \
    [ optional parameters ]

All examples shown here, unless implicitly stated otherwise, refer to the Enterprise version ( pandora_manage ).

Syntax

  • All parameters, mandatory or optional, can be delimited with single quotation marks.
  • Quotation marks are especially useful when a parameter has spaces, e.g. 'My Agent'.
  • Also if you need to omit some mandatory parameter you can use two single quotes together. If strictly necessary, an [ERROR] Error: message will be displayed followed by a description of the error. In the case of optional parameters, if there are several and you need to specify only the second and/or third and/or etcetera, use two single quotation marks together to indicate the empty optional parameters.
  • Some parameters are case sensitive, others are case insensitive. For example, when creating an agent the name of the PFMS server must be strictly the same, however the name of the primary group to which the agent will belong can be in upper and/or lower case and if there is a match the group will be assigned.

Help

To obtain general help with the Pandora FMS CLI use:

pandora_manage --h

To obtain help about one specific option just write option without parameters; for example for create an user:

pandora_manage /etc/pandora/pandora_server.conf --create_user

Agents (summary)

You may use agent alias instead agent name itself by using use_alias parameter at the end of line command.

  1. create_agent: Create an agent.
  2. update_agent: Update an agent field.
  3. agent_update_custom_fields: Update agent custom fields.
  4. delete_agent: Delete an agent.
  5. disable_group: Disable all agents from one group.
  6. enable_group: Enable all agents from one group.
  7. create_group: Create a group.
  8. delete_group: Delete a group.
  9. update_group: Update a group.
  10. stop_downtime: Stop a planned downtime.
  11. get_agent_status: Get the status of a given agent.
  12. get_agent_group: Get the group name of a given agent.
  13. get_agent_modules: Get the module list of a given agent.
  14. get_agents: Get list of agents with optative filter parameters.
  15. get_agents_id_name_by_alias: List id and alias of agents matching given alias.
  16. delete_conf_file: Delete a local conf of a given agent.
  17. clean_conf_file: Clean a local config file of a given agent deleting all modules, policies and collections data.
  18. get_bad_conf_files: Get the files bad configured (without essential tokens).
  19. migration_agent_queue: migrate an agent from one node to another with the Metaconsole (Enterprise version only).
  20. migration_agent: see if there is an agent in the migration queue (Enterprise version only).
  21. set_disabled_and_standby: Disable an agent and put it in standby mode (Enterprise version only).
  22. reset_agent_counts: Updates module counts and alert counts.

Modules (summary)

  1. create_data_module: Add one data module to one agent.
  2. create_web_module: Add one web module to one agent.
  3. create_network_module: Add one network module to one agent.
  4. create_network_component: Create a new network component.
  5. create_snmp_module: Add one SNMP module to one agent.
  6. create_plugin_module: Add one module kind plugin to one agent.
  7. get_module_group: Displays the filtered groups of available modules.
  8. create_module_group: Create a group (module type).
  9. module_group_synch: Synchronize group of modules from the Metaconsole (Enterprise version only).
  10. delete_module: Delete one module from one agent.
  11. data_module: Insert data to one module.
  12. get_module_data: Show data from one module in the last X seconds (interval) in CSV format.
  13. get_module_id: Show id from one module.
  14. get_module_custom_id: Shows the Custom ID of a module.
  15. 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.
  16. 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.
  17. update_module: Update one module field.

Alerts (summary)

  1. create_template_module: Add an alert template to an agent.
  2. delete_template_module: Delete an alert template from an agent.
  3. create_template_action: Create an action to one agent.
  4. delete_template_action: Delete an action from an agent.
  5. disable_alerts: Disable alerts in all groups.
  6. enable_alerts: Enable alerts in all groups.
  7. create_alert_template: Create an alert template.
  8. delete_alert_template: Delete an alert template.
  9. update_alert_template: Update field of an alert template.
  10. get_alert_actions: Allows to visualize the actions of alerts.
  11. get_alert_actions_meta: Allows to visualize the actions of node alerts from the Metaconsole (Enterprise version only).
  12. create_alert_command: Creates an alert command.
  13. get_alert_commands: Allows to visualize alert commands.
  14. validate_all_alerts: Validates all the alerts.

Users (summary)

  1. create_user: Create one user.
  2. delete_user: Delete one user.
  3. update_user: Update field of a user.
  4. enable_user: Enable a given user.
  5. disable_user: Disable a given user.
  6. create_profile: Create a new profile.
  7. update_profile: Update a profile.
  8. add_profile: Add a profile to an user.
  9. add_tag_to_user_profile: Add a tag to the given user profile.
  10. delete_profile: Delete a profile from an user.
  11. add_profile_to_user: Add a profile to a user in a group
  12. disable_eacl: Disable the ACL Enterprise system.
  13. enable_eacl: Enable the ACL Enterprise system.

Events (summary)

  1. create_event: Create an event.
  2. validate_event: Validate an event.
  3. validate_event_id: Validate an event given a event id.
  4. get_event_info: Display info about a event given a event id.
  5. event_in_progress: Set event in progress.

Policies (summary)

  1. create_policy: Create a policy.
  2. apply_policy: Force the application of a policy.
  3. apply_all_policies: Add to the application queue all the policies.
  4. add_agent_to_policy: Add an agent to a policy.
  5. add_collection_to_policy: Add a collection to a policy.
  6. recreate_collection: Recreate the files of a collection.
  7. create_policy_data_module_from_local_component: Create a data module from a local component to a policy.
  8. delete_not_policy_modules: Delete all the modules not associated to policies from the conf file.
  9. remove_agent_from_policy: Remove an agent from a policy.
  10. disable_policy_alerts: Disable all the alerts from a policy.
  11. create_policy_data_module: Create a policy data module.
  12. create_policy_web_module: Create a policy web module.
  13. create_policy_network_module: Create a policy network module.
  14. create_policy_snmp_module: Create a policy SNMP module.
  15. create_policy_plugin_module: Create a policy plugin module.
  16. validate_policy_alerts: Validate all the alerts of a given policy.
  17. get_policy_modules: Get the module list of a policy.
  18. get_policies: Get all the policies (without parameters) or the policies of a given agent (agent name as parameter).

Tools (summary)

  1. exec_from_file: Execute any CLI option using macros from a CSV file.
  2. create_snmp_trap: Creates a trap with a name which will be displayed in the trap console.
  3. start_snmptrapd: Start the snmptrapd process on the traps server.

Visual consoles (summary)

  1. create_visual_console: Create a visual console in pandora following the indicated scheme.
  2. edit_visual_console: Edit a visual console in pandora following the indicated scheme.
  3. delete_visual_console: Eliminate a visual console and all its associated elements.
  4. delete_visual_console_objects: Remove elements associated with a visual console following a filter.
  5. duplicate_visual_console: Duplicate a visual console as many times as indicated.
  6. export_json_visual_console: Exports a visual console and its elements to JSON format.

Graphs (summary)

  1. create_custom_graph: A graph will be created with the specified elements.
  2. edit_custom_graph: A graph with the specified elements will be edited.
  3. add_modules_to_graph: The modules specified in the selected chart will be added.
  4. delete_modules_to_graph: The modules specified in the selected chart will be deleted.

Clusters (summary)

  1. new_cluster: A cluster with the specified parameters and their associated elements will be created.
  2. add_cluster_agent: A specific agent will be added to the specified cluster.
  3. add_cluster_item (active / active): Adding item to cluster.
  4. add_cluster_item (active / pasive): Adding item to cluster.
  5. get_cluster_status: Getting cluster status.
  6. delete_cluster: A cluster will be deleted.
  7. delete_cluster_agent: An agent added to a cluster will be disassociated.
  8. delete_cluster_item: A cluster item will be deleted.

Others (summary)

  1. locate_agent: Searches for an agent in the nodes of a Metaconsole and returns its ID.
  2. create_tag: Create a new tag.

Agents

create_agent

Mandatory parameters:

  • < agent_name >
  • < operating_system>
    • It can be omitted by means of two single quotation marks together.
  • < group_name >
  • < server_name >
    • Be case sensitive, otherwise the field value will be left null without warning. Make sure that the agent has been assigned to a server.

Optional parameters:

  • < address IP or URL>
  • < description >
    • If you omit the description it will be added Created by < server_name >.
  • < interval >
  • < alias as name >

Description:

An agent with the name, the operating system, the group and the server specified will be created. Optionally, it will be possible to give it an address ( IP addres or name), a description and an interval in seconds (by default 300).

The parameter < alias as name > is set to 1 by default and, with that value, the alias will be the same as the agent name. If you want the name to be generated randomly this parameter must be set to 0. If any of the first three optional parameters are to be omitted, use single quotation marks together for each omission.

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --create_agent \
    'My agent' AIX Databases Central-Server \
    192.168.12.123 'Agent description' '' 0

update_agent

Mandatory parameters:

  • < name_of_agent >
  • < field >
  • < new_value >

Optional parameters:

  • use_alias

Description: A single given < field > of an existent agent will be updated. The possible fields are the following:

  • agent_name
  • address
  • description
  • group_name
  • interval
  • os_name
  • disabled ( 0 for activate it, 1 for inactivate it).
  • parent_name
  • cascade_protection ( 0 for inactivate it, 1 for activate it).
  • icon_path
  • update_gis_data ( 0 for inactivate it, 1 for activate it).
  • custom_id

To identify the agent by its alias instead of its name use use_alias just at the end.

Examples (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --update_agent \
    'My Agent' agent_name 'Agent 2'
pandora_manage /etc/pandora/pandora_server.conf --update_agent \
    'My Agent' description 'New note' \
    use_alias

agent_update_custom_fields

Version NG 758 or later.


Parameters: <id_agent> <type_field> <field_to_change> <new_value>

  1. id_agent → agent identifier.
  2. type_field → field type which can be 0 if it is a text type or 1 if it is a combobox (select) type composed of several options. See section on answers. Successful example:
  3. field_to_change → name of the field to be updated.
  4. new_value → the value of the field to be updated.

Description: updates the custom fields of an agent.

The answers of which they are composed are:

  • ERROR:
    1. If the agent does not exist.
    2. If the field does not exist.
    3. In the event that the new_value of a combo does not match the ones you have preset.
    4. If you were unable to update the field.
  • INFO:
    1. Updating the X field with the agent id Y.
    2. Correctly updated.

Examples (see call and syntax):

TEXT TYPE:

pandora_manage /etc/pandora/pandora_server.conf --agent_update_custom_fields 1 0 'Serial number' 'john'

COMBO TYPE:

pandora_manage /etc/pandora/pandora_server.conf --agent_update_custom_fields 1 1 'Names' 'john'

delete_agent

Mandatory parameter:

  • < agent_name >

Optional parameter:

  • use_alias
    • Note that agent aliases can be repeated and you can delete several agents in one step.

Description:

The agent(s) will be deleted by passing its name or alias as a parameter.

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf \
    --delete_agent 'My Agent' \
    use_alias

disable_group

Manadory parameter:

  • < group_name >

Description:

Disable all agents from an entire group. The agents of the group considered as parameter will be disabled with the execution of this option.

If you pass All as group, all agents from all groups will be disabled.

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --disable_group Firewalls

enable_group

Mandatory parameter:

  • < group_name >

Description:

The agents of the group considered as parameter will be disabled with the execution of this option. If you pass 'All' as group all agents from all groups will be enabled.

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --enable_group firewalls

create_group

Mandatory parameters:

  • < group_name >

Optional paramaters:

  • < parent_group_name >
  • < icon >
    • applications
    • application_osx
    • application_osx_terminal
    • bricks
    • chart_organisation
    • clock
    • computer
    • database
    • database_gear
    • docker
    • drive_network
    • email
    • eye
    • firewall
    • heart
    • house
    • images
    • lightning
    • lock
    • network
    • plugin
    • printer
    • server_database
    • transmit
    • vmware
    • without_group
    • world
  • < 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, choose one from list above) and description. The parent group by default is 'All' and the default icon is empty string (without icon).

If you need to add a description:

  • If you will not use parent group set All as fill parameter.
  • If no icon is to be used, place an empty string (two single quotes together) as the filler parameter.


Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --create_group \
    'New group name' \
    Web computer 'New description.'

delete_group

Mandatory parameter:

  • < group_name >

Description:

Delete an agent group.

Every agent belongs to indicated group will be deleted too.

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf –-delete_group 'Group name'

update_group

Mandatory parameters:

  • < group_id >

Optional parameters:

  • < group_name_to_modify >
  • < parent_group_name >
  • < icon >
    • applications
    • application_osx
    • application_osx_terminal
    • bricks
    • chart_organisation
    • clock
    • computer
    • database
    • database_gear
    • docker
    • drive_network
    • email
    • eye
    • firewall
    • heart
    • house
    • images
    • lightning
    • lock
    • network
    • plugin
    • printer
    • server_database
    • transmit
    • vmware
    • without_group
    • world
  • < description >

Description: A group is modified by its numerical identifier. Parameters that can be modified:

  • Name group.
  • Name group parent
  • Icon (only name, without extension, choose one from list above).
  • Description.
  • You can use the “ get_agent_group_id ” function to find the id of the group of any agent.
  • At Web console go to menu ►ProfilesManage agent groups and take number id.

You must type exactly same existing parameters for only modify description field.


Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf –update_group 18 \
    'Group name' 'Web' 'transmit' 'Description'

stop_downtime

Mandatory parameter:

  • < downtime_name >

Description:

Stop a planned downtime. If the downtime is finished, a message will be showed. Returning messages:

  • [ERROR] Planned_downtime < downtime_name > cannot be stopped.
  • [INFO] Planned_downtime < downtime_name > is already stopped.
  • [INFO] Stopping planned downtime < downtime_name >

Example (see call and syntax):

pandora_manage.pl /etc/pandora/pandora_server.conf --stop_downtime 'Downtime name'

get_agent_status

Required parameter:

  • < agent_name >

Optional parameter:

  • use_agent_alias

    To identify the agent by its alias instead of its name, use use_agent_alias right at the end.

Description: Get the status of a given agent by its name or alias.

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --get_agent_status 'agent name'

get_agent_group

Required parameter:

  • < agent_name >

Optional parameter:

  • use_agent_alias

    To identify the agent by its alias instead of its name, use use_agent_alias right at the end.

Description: Get the group of a given agent by its name or alias.

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --get_agent_group 'agent_name'

get_agent_group_id

Required parameter:

  • < agent_name >

Optional parameter:

  • use_agent_alias

    To identify the agent by its alias instead of its name, use use_agent_alias right at the end.

Description: Get the identification group of a given agent by its name or alias.

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --get_agent_group_id 'agent name'

get_agent_modules

Required parameter:

  • < agent_name >

Optional parameter:

  • use_agent_alias

    To identify the agent by its alias instead of its name, use use_agent_alias right at the end.

Description: Get the modules (identifications and names, separated by a comma) of a given agent by its name or alias.

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --get_agent_modules 'agent name'

get_agents

Required parameter: None. To get help for such a command you can use (see call and syntax):

 pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' '' '' '' '' '' ''

You will get the following response indicating that it exceeds the number of parameters:

[ERROR] Parameters error: 8 received | 0-7 necessary.
 
Pandora FMS CLI 7.0NG.764 Build 220930 Copyright (c) 2013-2021 Artica ST
This program is Free Software, licensed under the terms of GPL License v2
You can download latest versions and documentation at http://www.pandorafms.org
 
[*] Pandora FMS Enterprise module loaded.
 
Available options for --get_agents:
 
        --get_agents [<group_name> <os_name> <status> <max_modules> <filter_substring> <policy_name> <use_alias>] : Get
          list of agents with optative filter parameters.

Optional parameters: Allow filtering the list of agents in a serialized format where the order matters, use two single quotes to skip parameter(s). They are numbered here for better control and visualization:

  1. < os_name >
  2. < status > Posible values: critical, warning, unknown, normal.
  3. < number_max_of_modules >
  4. < key_string > Allows filtering by agent name (or agent alias if you add at the end use_agent_alias ).
  5. < policy_name >
  6. use_agent_alias

Description: Get all agents (without parameters) or agents according to a filter.

Examples (see call and syntax):

  • Get all agents in the Network group:
pandora_manage /etc/pandora/pandora_server.conf --get_agents 'Network' '' '' '' '' ''
  • Get all the agents that have Linux as operating system:
pandora_manage /etc/pandora/pandora_server.conf --get_agents '' 'Linux' '' '' '' ''
  • Obtain all agents whose status is normal:
pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' 'normal' '' '' ''
  • Obtain all agents with zero modules (no modules at all):
pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' '' '0' '' ''
  • Get all agents with zero modules in the Servers group:
pandora_manage /etc/pandora/pandora_server.conf --get_agents 'Servers' '' '' '0' '' ''
  • Get all agents that contain the word test in their alias:
pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' '' '' 'test' '' use_agent_alias

get_agents_id_name_by_alias

Parameters: <agent_alias> [ strict ]

Description: List id and alias of agents matching given alias. Using strict limits search only to exact alias.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agents_id_name_by_alias 'station'

Delete_conf_file

(>=5.0)

Parameters: <agent_name> <use_agent_alias>

Description: The conf file of one agent will be deleted

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_conf_file 'Agent name'

Clean_conf_file

(>=5.0)

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).

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --clean_conf_file 'Agent name'

Get_bad_conf_files

(>=5.0)

Parameters: No

Description: A list of the bad configurated conf files will be showed (Files without main tokens: server_ip,server_path,temporal,logfile)

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_bad_conf_files

migration_agent_queue

(>=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]

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:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --migration_agent_queue 1 nodo1 nodo2 0

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

migration_agent

(>=7.21) only for metaconsole 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

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --migration_agent 1

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

create_downtime

Parameters: <downtime_name> <description> <date_from> <date_to> <id_group> <monday (0|1)> <tuesday (0|1)><wednesday (0|1)> <thursday (0|1)> <friday (0|1)> <saturday (0|1)> <sunday (0|1)> <periodically_time_from HH:MM:SS><periodically_time_to HH:MM:SS> <periodically_day_from> <periodically_day_to><type_downtime> <type_execution> <type_periodicity> <id_user>

Description: Created Planned downtime.

  • You must have configured data API in pandora_server.conf.
  • The date format must be MM/DD/YYYY (Month/Day/Year) for this call to work properly.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_downtime Testing Testing 05/07/2022 06/07/2022 0 1 1 1 1 1 1 1 17:07:00 18:08:00 1 31 quiet periodically weekly 7

add_item_downtime

Mandatory parameters:

  • < id_parada_planificada >
  • < id_agente1,id_agente2,id_agente3,…,id_agenteN >
  • < nombre_módulo1,nombre_módulo2,nombre_módulo3,…,nombre_móduloN >

Description:

Records will be added to a scheduled stop with the submitted data. Write the list of agent identifiers and the list of module names without leaving spaces between the commas that separate the components of both lists. If a module name contains spaces, enclose the module name in two single quotes. If two or more agents are passed, it is assumed by default that you want to add common modules, otherwise it will display a warning message.

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --add_item_downtime 1 1 Status,'Available Memory'

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

get_all_planned_downtimes

Mandatory parameters:

  • < name_to_search >

Optional parameters:

  • < id_group >
  • < type_downtime >
    • quiet
    • disable_agents
    • disable_agents_alert
  • < type_execution >
    • once
    • periodically
  • < type_periodicity >
    • weekly
    • monthly

Description:

List all matches of planned downtime. See Scheduled downtimes options.

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --get_all_planned_downtimes ''

get_planned_downtimes_items

Mandatory parameters:

  • < name_to_search >

Optional parameters:

  • < id_group >
  • < type_downtime >
    • quiet
    • disable_agents
    • disable_agents_alert
  • < type_execution >
    • once
    • periodically
  • < type_periodicity >
    • weekly
    • monthly

Description:

List all of items that matches planned downtime name. See Scheduled downtimes options.

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --get_planned_downtimes_items 'Name downtime'

set_planned_downtimes_deleted

Mandatory parameter:

  • < id_planned_downtime >

Description:

Delete a planned downtime especified by ID. Some return messages:

This planned downtime is deleted

Problems with this planned downtime

The scheduled downtime is still being executed

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --set_planned_downtimes_deleted 7

set_disabled_and_standby

Enterprise version Only for Metaconsole and Nodes.


Required parameters:

  • < id_agent >
  • For Metaconsole < id_metaconsole >, for nodes put any value, is indifferent.

Optional parameter:

  • < value> By default 1 for enable agent, 0 for disabled.

Description: Disable an agent and, if it has remote configuration, set to standby mode.

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

Example (see call and syntax):

  • Example to enable an agent from the node:
perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 0 1
  • Example to disable an agent from the node:
pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 0 0
  • Example to enable an agent from the metaconsole:
pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 1 1
  • Example to disable an agent from the metaconsole:
pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 1 0

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

reset_agent_counts

Parameters: <id_agent>

Description: Synchronizes module counts and alerts for a given agent. If you want to synchronize with all agents, the first parameter must be “All”.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --reset_agent_counts "All"

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

insert_gis_data

Mandatory parameters:

  • < id_of_agent >
  • < latitude >
  • < longitude >
  • < altitude >

Optional parameters:

  • None.

Description: Updates an agent's GIS data.

Examples (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --insert_gis_data 1 2 3 4

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

get_gis_agent

Mandatory parameters:

  • < id_of_agent >

Optional parameters:

  • None.

Description: Gets an agent's GIS data.

Examples (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --get_gis_agent 1

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

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.

The module definition file will contain some like this:

module_begin
module_name My module
module_type generic_data
module_exec cat /proc/meminfo  | grep MemFree | awk '{ print $2 }'
module_end

The default values are 0 for the minimum and maximum, history_data and post_process and 300 for the interval.

Notes:

The next parameters are only for the Pandora FMS version 5 and next versions:

  • <enable_unknown_events>

The next parameters are only for the Pandora FMS version 5.1 and next versions:

  • <ff_threshold>
  • <each_ff>
  • <ff_threshold_normal>
  • <ff_threshold_warning>
  • <ff_threshold_critical>
  • <ff_timeout>

The next parameters are only for the Pandora FMS version 6 and next versions:

  • <warning_inverse>
  • <critical_inverse>

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'

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

(>=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>

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.

The module definition file will contain some like this:

task_begin
get http://pandorafms.com
task_end

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 'http://proxy.url' 'proxy_login' 'proxy_password' 1 10 10 10 10 10 10 10 10 1 1 'critical_instructions' 'warning_instructions' 'unknown_instructions'

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:

A network module will be created in an agent with the module name, kind of module, name of the agent where it will be created and the module address specified. Optionaly, it will be possible to give it a port, a description, values min and max, a post_process value, an interval in seconds, a warning min and max values, critical min and max values and a history data value.

The default values are 0 for the min and max, history_data and post_process an another 300 for the interval.

the port is optional, so the modules kind ICMP don't need it. In the rest of kinds, it is necessary to specify one module.

Notes:

The next parameters are only for the Pandora version 5 and next versions:

  • <enable_unknown_events>

The next parameters are only for the Pandora version 5.1 and next versions:

  • <each_ff>
  • <ff_threshold_normal>
  • <ff_threshold_warning>
  • <ff_threshold_critical>

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

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:

A network component will be created. Optionaly, it will be possible to give it a port, a description, values min and max, a post_process value, an interval in seconds, a warning min and max values, critical min and max values and a history data value.

The default values are 0 for the min and max, history_data and post_process an another 300 for the interval.

the port is optional, so the modules kind ICMP don't need it. In the rest of kinds, it is necessary to specify one module.

Notes:

The next parameters are only for the Pandora version 5 and next versions:

  • <enable_unknown_events>

The next parameters are only for the Pandora version 5.1 and next versions:

  • <each_ff>
  • <ff_threshold_normal>
  • <ff_threshold_warning>
  • <ff_threshold_critical>

Example:

perl /tmp/pandorafms/pandora_server/util/pandora_manage.pl /etc/pandora/pandora_server.conf --create_network_component "example_name" 2 7

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

Create_snmp_module

Parameters: <module_name> <module_type> <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> <unknown_events> <each_ff> <ff_threshold_normal> <ff_threshold_warning> <ff_threshold_critical> <timeout> <retries> <use_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.

The default values are 0 for the min and max, history_data and post_process and 300 for the interval.

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

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.

The values by default are 0 for min and max, history_data and post_process and 300 for the interval.

Notes:

The next parameters are only for the Pandora version 5 and next versions:

  • <enable_unknown_events>

The next parameters are only for the Pandora version 5.1 and next versions:

  • <each_ff>
  • <ff_threshold_normal>
  • <ff_threshold_warning>
  • <ff_threshold_critical>

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

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.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_group "grupo de módulos"

Create_module_group

Parameters: <module_group_name>

Description: A module group will be created with the module_group_name

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_module_group 'My module group'

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.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --module_group_synch "server_name1|server_name2|server_name3" "json"

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

Create_synthetic

Parameters: <module_name> <synthetic_type> <agent_name> <opts> <use_agent_alias>

Where <synthetic_type> can be “arithmetic” or “average”.

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>

Let's explain all the posible parameters that can be used on the <opts»

  • <opts> = <source_agent1>,<operator>,<source_module1> <source_agent2>,<operator>,<source_module2>
  • <opts> = <source_agent1>,<operator>,<source_module1> <operator>,<fixed_value>

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
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module average example_agent my_agent,x,my_module my_agent,x,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. On the second 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 * 10. On the third example, we will create in the agent example_agent an average type of module named example_module. Its content will be the average value betwee my_module and my_module2.

The first operator that is used, on the previous case between my_agent and my_module (+), is ignored and doesn't affect to the result of the operations, but it is needed due to the internal structure of the tool. It's very important to keep into account that the arithmetic operation will be done with the next (in this case, the second) operator, on the current example, between my_agent2 and my_module2, or right before the value 10 (in this case, operators “-” or “*”). The possible operators are:

  • + sum
  • - substraction
  • * multiplication
  • / division
  • x average. This operator only can be used with the average type.

Note:

Available in Pandora 5.1 SP4 and above

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 traffic_difference arithmetic nodo51sp3 nodo51sp3,+,InputTraffic nodo51sp3,-,OutputTraffic

Delete_module

Parameters: <module_name> <agent_name> <use_agent_alias>

Description: An agent module will be eliminated considering both as parameters

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_module 'My module' 'My agent'

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.

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

(>=5.0)

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 ';'

Example:

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>

Description: The id of a module of an agent is returned.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_id 4 'host alive'

Get_module_custom_id

Parameters: <agentmodule_id>

Description: The value of the field Custom ID of a specific module of an agent will be returned.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_custom_id 4

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.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_module_custom_id 4 '21'

Delete_data

Parameters: <module_name> <agent_name> | -a <agent_name> | -g <group_name> <use_agent_alias>

Description: All data associated to a module will be deleted from the historical data in case of having as parameter -m and the name of this one and its agent name; from the agent modules if as parameter the option '-a' is given, and the agent or modules name of all agents from a group, if as parameter the option '-g' and the group name is given.

Example:

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.

Update_module

Parameters: <module_name> <agent_name> <field_to_update> <new_value> <use_agent_alias>

Description: A given field of an existent data module will be updated. The module type will be detected to allow update the specific fields for each type.

The possible fields are the following:

  • Common to any module: module_name, agent_name, description, module_group, min, max, post_process, history_data, interval, warning_min, warning_max, critical_min, critical_max, warning_str, critical_str, ff_threshold, each_ff, ff_threshold_normal, ff_threshold_warning, ff_threshold_critical, critical_instructions, warning_instructions, unknown_instructions
  • For the data modules: ff_timeout
  • For the network modules: module_address, module_port
  • For the SNMP modules: module_address, module_port, version, community, oid, snmp3_priv_method, snmp3_priv_pass, snmp3_sec_level, snmp3_auth_method, snmp3_auth_user, snmp3_priv_pass
  • For the plugin modules: module_address, module_port, plugin_name, user, password, parameters

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_module 'Module name' 'Agent name' description 'New description'

add_tag_to_module

Parameters: <agent_name> <module_name> <tag_name>

Description: Add a tag to the given module.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_tag_to_module 'Agent name' 'Module name' 'Tag name'

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

Get_agents_module_current_data

(>=5.0)

Parameters: <module_name>

Description: Get the agent and current data of all the modules with a given name.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agents_module_current_data 'Module name'

Create_network_module_from_component

(>=5.0)

Parameters: <agent_name> <component_name> <use_agent_alias>

Description: Create a new network module in the specified agent from a network component.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_network_module_from_component 'Agent name'

Create_data_module_from_local_component

(>=5.1)

Parameters: <agent_name> <component_name> <use_agent_alias>

Description: Create a new data module in the specified agent from a local component.

Example:

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)

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.

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

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.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --apply_module_template 1 1

Alerts

Create_template_module

Parameters: <template_name> <module_name> <agent_name> <use_agent_alias>

Description: A template will be assigned to an agent module giving it the template name, the module and the agent as parameters.

Example:

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>

Description: it'll be unassigned a module template of one agent giving it the template name, the module and the agent as parameters.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_template_module plantilla001 'Mi modulo' 'Mi agente'

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).

Example:

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>

Description: It'll be added an action to an alert giving as parameters the names of the action, template, module and agent that composes the alert.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_template_action action012 template001 'My module' 'My agent'

Disable_alerts

Parameters: No

Description: All alerts will be disabled with the execution of this option.If when it's executed we have any alert disabled and we activate all again, this one will be also enabled.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_alerts

Enable_alerts

Parameters: No

Description: All the alerts will be activated with the execution of this option. If when it's executed we had any alert enabled and we disabled all again, this one will be also disabled.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_alerts

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.

The field <condition_type_serialized> is the type options of the template serialized with the separator ';' by default. It's possible change the separator with the parameter <condition_type_separator> to avoid conflicts some options if it could contain the default character.

The possibilities are the following:

NOTE: In this examples is used the default separator ';' and the field matches_value is a binary value to set if the alert will be fired when the value match or when the value not match with the conditions.

  • Regular expression:
    • Syntaxis: <type>;<matches_value>;<value>
    • Example: regex;1;stopped|error (Alert when value match regexp 'stopped|error')
  • Max and min:
    • Syntaxis: <type>;<matches_value>;<min_value>;<max_value>
    • Example: max_min;0;30;50 (Alert when value is out of interval 30-50)
  • Max.:
    • Syntaxis: <type>;<max_value>
    • Example: max;70 (Alert when value is above 70)
  • Min.:
    • Syntaxis: <type>;<min_value>
    • Example: min;30 (Alert when value is below 30)
  • Equal to:
    • Syntaxis: <type>;<value>
    • Example: equal;0 (Alert when value is equal to 0)
  • Not equal to:
    • Syntaxis: <type>;<value>
    • Example: not_equal;100 (Alert when value is not equal to 100)
  • Warning status:
    • Syntaxis: <type>
    • Example: warning (Alert when status turns into warning)
  • Critical status:
    • Syntaxis: <type>
    • Example: critical (Alert when status turns into critical)
  • Not normal:
    • Syntaxis: <type>
    • Example: not_normal (Alert when status differs from normal)
  • Unknown status:
    • Syntaxis: <type>
    • Example: unknown (Alert when status turns into unknown)
  • On Change:
    • Syntaxis: <type>;<matches_value>
    • Example: onchange;1 (Alert when value changes)
  • Always:
    • Syntaxis: <type>
    • Example: always (Alert all times)

The field <days> is seven binary characters that specify the days of the week when the alert will be activated. i.e.: 0000011 to activate the alert only Saturday and Sunday.

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

(>=5.0)

Parameters: <template_name>

Description: An alert template will be deleted if exists.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_alert_template 'Template name'

Update_alert_template

(>=5.0)

Parameters: <template_name> <field_to_update> <new_value>

Description: A given field of an existent alert template will be updated. The possible fields are the following: name, description, type, matches_value, value, min_value, max_value, time_threshold(0-1), time_from, time_to, monday(0-1), tuesday(0-1), wednesday(0-1), thursday(0-1), friday(0-1), saturday(0-1), sunday(0-1), min_alerts, max_alerts, recovery_notify(0-1), field1, field2, field3, recovery_field2, recovery_field3, priority(0-4), default_action, group_name.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_alert_template 'Template name' priority 4

Get_alert_actions

(>=5.0)

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).

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_alert_actions 'Action 1' ';' 'json'

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

Get_alert_actions_meta

(>=5.0)

This feature is in Metaconsole.

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).

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_alert_actions_meta // 'Action 1' ';' 'json'

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

Create_alert_command

(>=5.0)

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:

  • Group name. If no group is provided, it will be assigned in the group 'All'.
  • Command Description.
  • Internal (1-0).
  • Field description. This will be formatted as follows: '[“descr1”,“descr2”,“descr3”,“descr4”,“descr5”]'.
  • Field value: This will be formatted as follows: [“val1”,“val2”,“val3”,“val4”,“val5”].

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

(>=5.0)

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.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf  --get_alert_commands "command_name"

validate_alert

Parameters: <template_name> <agent_id> <module_id> [ use_alias ]

Description: Validate an alert given a template name, an agent ID and a module ID. Instead use only an agent ID you may use name agent with last parameter use_alias (maybe for validate multiple alerts).

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf  --validate_alert 7 10 15

Validate_all_alerts

(>=5.0)

Parameters: None

Description: Validate all the alerts.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_all_alerts

Create_special_day

(>=5.1)

Parameters: <special_day> <same_day> <description> <group_name>

Description: Create a special day. The possible same_days are monday, tuesday, wednesday, thursday, friday, saturday and sunday.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_special_day 2014-05-03 sunday Desc All

Delete_special_day

(>=5.1)

Parameters: <special_day>

Description: Delete specified special day.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_special_day 2014-05-03

set_event_storm_protection

Parameters: <value>

Description: Enable (1) or disable (0) event storm protection.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_event_storm_protection 1

Update_special_day

(>=5.1)

Parameters: <special_day> <field_to_change> <new_value>

Description: Update specific field of a special day with new value. The possible fields are same_day, description and group_name. When same_day is set, possible new_values are monday, tuesday, wednesday, thursday, friday, saturday and sunday.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_special_day 2014-05-03 same_day monday

Users

create_user

NG 766 version or later: This function also works in Metaconsole.

Required parameters:

  • < id_user >
  • < password >
  • < is_admin >

Optional parameters:

  • < comments >

Description:

A user will be created with the user ID (which will also be the user name) and the password received. In addition a binary value ( < is_admin > 0 false or 1 true) will be received specifying whether the user will be an superadmin or not. Optionally a comment about the created user can be added.

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --create_user user9500 'user 9500' 0 'This user has the password "user 9500"'

delete_user

NG 766 or later: This function also works in Metaconsole.

Required parameter:

  • <id_user >

Description:

An user will be eliminated giving its name as parameter.

Example (see call and syntax):

pandora_manage.pl /etc/pandora/pandora_server.conf --delete_user user02

update_user

NG 766 or later: This function also works in Metaconsole.

Required parameters:

  • < id_user >
  • < field_to_update >
  • < new_value >

Description:

A given field of an existent user will be updated. The possible fields are the following:

  • email.
  • phone.
  • is_admin ¿Is superadmin? (0 false,1 true).
  • language , possible values:
    • default, English US.
    • ca, Catalan.
    • en_GB, English UK.
    • es, Spanish.
    • fr, French.
    • ru, Russian.
    • ja, Japanese.
    • zh_CN , Chinese.
  • id_skin (only works in Enterprise version) Change skin graphical for user.
  • comments.
  • fullname.
  • password.

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --update_user 'user 9500' password 'XYZ'

enable_user

NG 766 or later: This function also works in Metaconsole.

Required parameter:

  • < user_id >

Description:

An existent user will be enabled. If it's already enabled, will showed only a message.

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --enable_user 'user 9500'

disable_user

NG 766 or later: This function also works in Metaconsole.

Required parameter:

  • < user_id >

Description:

An existent user will be disabled. If it's already disabled, will showed only a message.

Example (see call and syntax):

pandora_manage.pl /etc/pandora/pandora_server.conf --disable_user 'user 9500'

create_profile

NG 766 or later: This function also works in Metaconsole.

Required parameters:

  • < profile_name >
  • < rights_list > Use 1 or 0 for otorgate or deny right, respectively. They are numbered so:
    1. AR View agents.
    2. AW Edit agents.
    3. AD Disable agents.
    4. LW Edit alerts.
    5. LM Manage alerts.
    6. UM Manage users.
    7. DM Manage database.
    8. ER View events.
    9. EW Edit events.
    10. EM Manage events.
    11. RR View reports.
    12. RW Edit reports.
    13. RM Manage reports.
    14. MR View network maps.
    15. MW Edit network maps.
    16. MM Manage network maps.
    17. VR View visual console.
    18. VW Edit visual console.
    19. VM Manage visual console.
    20. PM Pandora FMS management.
    21. NR View NCM data.
    22. NW Operate NCM -you must include NR-.
    23. NM Manage NCM -you must include NW and NR-.

Descripción:

A new profile will be created by passing the profile name and permissions as parameters. All fields are required.

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --create_profile Profile01 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

update_profile

NG 766 or later: This function also works in Metaconsole.

Required parameters:

  • < profile_name >
  • < rights_list > Use 1 or 0 for otorgate or deny right, respectively. They are numbered so:
    1. AR View agents.
    2. AW Edit agents.
    3. AD Disable agents.
    4. LW Edit alerts.
    5. LM Manage alerts.
    6. UM Manage users.
    7. DM Manage database.
    8. ER View events.
    9. EW Edit events.
    10. EM Manage events.
    11. RR View reports.
    12. RW Edit reports.
    13. RM Manage reports.
    14. MR View network maps.
    15. MW Edit network maps.
    16. MM Manage network maps.
    17. VR View visual console.
    18. VW Edit visual console.
    19. VM Manage visual console.
    20. PM Pandora FMS management.
    21. NR View NCM data.
    22. NW Operate NCM -you must include NR-.
    23. NM Manage NCM -you must include NW and NR-.

Descripción:

A existent profile will be updated by passing the profile name and permissions as parameters. All fields are required.

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --update_profile Profile01 1 0 1 0 1 0 1 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0

add_profile

NG 766 or later: This function also works in Metaconsole.

Required parameters:

  • < id_user >
  • < profile_name >
  • < group_name >

Description:

A profile will be added to an user giving it as parameter the names of user, profile an group on which they will have the privileges of this profile. You should specify the group All if you want that the profile has validity on all groups.

Example (see call and syntax):

pandora_manage.pl /etc/pandora/pandora_server.conf --add_profile usuario002 'Group coordinator' All

add_tag_to_user_profile

Parameters: <user_id> <tag_name> <group_name> <profile_name>

Description: Add a tag to the given user profile.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_tag_to_user_profile '7' 'new tag' 'All' 'Profile for user 7'

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

delete_profile

NG 766 or later: This function also works in Metaconsole.

Required parameters:

  • < id_user >
  • < profile_name >
  • < group_name >

Description:

An user profile will be deleted giving it as parameter the names of user, profile and group on which the profiles has the priviledges. If the profile to delete is associated to the All group, we should specify as group All.

Example (see call and syntax):

pandora_manage /etc/pandora/pandora_server.conf --delete_profile user02 'Chief Operator' Applications

add_profile_to_user

NG 766 or later: This function also works in Metaconsole.

Required parameters:

  • < id_user >
  • < profile_name >

Optinal parameter:

  • < group_name >

Description:

Add a existing profile in group to a user. If the group is not provided, the grupo will be All.

Example (see call and syntax):

pandora_manage.pl /etc/pandora/pandora_server.conf --add_profile_to_user 'user01' 'Chief Operator' 'Network'

disable_eacl

Parameters: Nothing.

Description: The Enterprise mode ACL system will be disabled in the configuration with the execution of this option.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_eacl

enable_eacl

Parameters: Nothing.

Description: The Enterprise mode ACL system will be enabled in the configuration with the execution of this option.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_eacl

disable_double_auth

Mandatory parameter: <id_user>

Description: The double authentication will be disabled for the specified user.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_double_auth 'admin'

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:

  • agent name
  • module name
  • event state (0 if it isn't validated and 1 if it is)
  • severity (from 1 to 4)
  • severity: 0 (Maintenance), 1 (Informational), 2 (Normal), 3 (Warning), 4 (Critical).

From version 5.0 there are 5 (Minor) y 6 (Major) too.

  • template name in the case that is would be associated to one alert.
  • user name
  • comment
  • source
  • Extra id
  • tags: Format should be <tag> <url>,<tag> <url>

You can add multiple tags separated by commas

  • custom data: Custom data should be entered as a JSON document. For example: '{“Location”: “Office”, “Priority”: 42}'
  • Force creation of agent (bool): If the agent name parameter refers to an agent that does not exist, it will be created.
  • Critical instructions: Add the instructions to be performed in the case of a critical condition
  • Warning instructions: Add the instructions to be performed in the case of a warning condition
  • Unknown instructions: Add the instructions to perform in case of going to unknown state

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:

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>

Description: All events will be validated considering a group of filters. The configurable filters are: the agent name, the module name, date-hour minimum and date-hour maximum, the user name, the severity and the name of the associated template.

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

Validate_event_id

(>=5.0)

Parameters: <id_event>

Description: A event will be validated.

Example:

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.

Get_event_info

(>=5.0)

Parameters: <id_event>[<separator]

Description: Display info about a event given a id.

Example:

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 |

add_event_comment

Required parameters:

  • < id_event >
  • < id_user >
  • < comment >

Description:

Add a comment to an event.

Example (see call and syntax):

pandora_manage /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.

event_in_progress

Parameters: <id_event>

Description: Set event in progress.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --event_in_progress 123

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

Policies

Create_policy

Parameters: <policy_name> <group> <description>

Description: A policy will be created with policy name, group and description. The description is not mandatory.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy 'My policy' 'My group' 'Description'

Apply_policy

Parameters: <policy_name>

Description:A policy passed as parameter will be forcibly applied. Within the process of applying a policy is: the creation of the modules of the policy in all its associated agents, the creation of the alerts of the policy in the created modules, and the accomplishment of changes in the configuration file of the local agents that the policy may have to add the created modules and the collections associated to the policy.

As this command works through the API, it needs the following parameters:

  • id =<id_policy> (required)
  • 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 =<serialized parameters>
    • <name_agent (Boolean)> Indicates if the agent will be sent by Id (0) or by name (1).
    • <server_id> (required if using Metaconsole) Id of the server in which the policy will be applied.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --apply_policy 'policy_id' 'agent_id' 'other1|other2'

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

Apply_all_policies

(>=5.0)

Parameters: None

Description: Add to the application queue all the policies. The server is who watch the queue and apply the policies

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --apply_all_policies

Add_agent_to_policy

(>=5.0)

Parameters: <agent_name> <policy_name> <use_agent_alias>

Description: An existent group will be added to an existent policy

Example:

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>

Description: An existent collection will be added to an existent policy

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_collection_to_policy 'Policy name' 'Collection name'

recreate_collection

Version EnterpriseParameters: <collection_id>

Description: Recreate the files of a collection. Returns [INFO] Collection recreated successfully. otherwise [ERROR] Collection not recreated.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --recreate_collection 7

Create_policy_data_module_from_local_component

Parameters: <policy_name> <component_name>

Description: A module will be created from a local component to a policy

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

Parameters: Nothing.

Description: All modules that doesn't belong to any policy will be deleted both from the database and the agent configuration file (if there is one).

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_not_policy_modules

Remove_agent_from_policy

Parameters: <id_policy> <id_agent>

Description:Removes an agent from a policy. It is necessary to specify the id of the policy and the id of the agent to be deleted.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --remove_agent_from_policy '11' '2'

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

Disable_policy_alerts

Parameters: <policy_name>

Description: All the alerts from a policy passed by parameter will be flagged as disabled

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_policy_alerts 'My policy'

Create_policy_data_module

(>=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>

Description: A policy data module will be created. The default values are the same of –create_data_module option

Notes:

The next parameters are only for the Pandora version 5.1 and next versions:

  • <ff_threshold>
  • <each_ff>
  • <ff_threshold_normal>
  • <ff_threshold_warning>
  • <ff_threshold_critical>
  • <ff_timeout>

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

(>=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>]

Description: A policy web module will be created. The default values are the same of –create_web_module option

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" '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)

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

Notes:

The next parameters are only for the Pandora version 5.1 and next versions:

  • <each_ff>
  • <ff_threshold_normal>
  • <ff_threshold_warning>
  • <ff_threshold_critical>

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

(>=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>]

Description: A policy SNMP module will be created. The default values are the same of –create_snmp_module option

Notes:

The next parameters are only for the Pandora version 5.1 and next versions:

  • <each_ff>
  • <ff_threshold_normal>
  • <ff_threshold_warning>
  • <ff_threshold_critical>

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

(>=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>]

Description: A policy plugin module will be created. The default values are the same of –create_plugin_module option

Notes:

The next parameters are only for the Pandora version 5.1 and next versions:

  • <each_ff>
  • <ff_threshold_normal>
  • <ff_threshold_warning>
  • <ff_threshold_critical>

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

(>=5.0)

Parameters: <policy_name>

Description: Validate all the alerts of a given policy

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_policy_alerts 'Policy name'

Get_policy_modules

(>=5.0)

Parameters: <policy_name>

Description: Get the module list (id and name) of a given policy

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_policy_modules 'Policy name'

Get_policies

(>=5.0)

Parameters: [<agent_name> <use_agent_alias>]

Description: Get all the policies (without parameters) or the policies of a given agent (agent name as parameter)

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_policies 'Agent name'

Netflow

Create_netflow_filter

(>=5.0)

Parameters: <filter_name> <group_name> <filter> <aggregate_by> <output_format>

Description: Create a new netflow filter.

The possible values of aggregate_by parameter are: dstip,dstport,none,proto,srcip,srcport The possible values of ouput_format parameter are: kilobytes,kilobytespersecond,megabytes,megabytespersecond

Example:

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

Tools

Exec_from_file

(>=5.0)

Parameters: <option_to_execute> <option_params>

Description: With this option is possible to execute any CLI option with macros from a CSV file. The number of macros will be the number of columns in the CSV file. Each macro will be named FIELD1 , FIELD2 , FIELD3 etc.

Example:

We are going to create users from a CSV file.

We need a CSV file like that:

 User 1,Password 1,0
 User 2,Password 2,0
 User 3,Password 3,0
 User Admin,Password Admin,1

The name of the file will be '/tmp/users_csv'

We are going to execute the option –create_user with the following options: <user_name> <user_password> <is_admin> <comments>

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'

NOTE: Commas into the CSV columns are not yet supported

create_snmp_trap

Parameters: <name> <oid> <desc> <severity>

Name: As seen in the snmp trap console.

OID: SNMP trap main OID.

Severity: Numeric value, which have following values: Severity 0 (Maintenance), 1(Info) , 2 (Normal), 3 (Warning), 4 (Critical), 5 (Minor) and 6 (Major).

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

start_snmptrapd

Parameters: Nothing.

Starts the snmptrapd process on the traps server. In case it is already started, it terminates the service (kill command) and runs it again, deleting all the traps located in the exchange log (by default /var/log/pandora/pandora_snmptrapd.log).

Example:

pandora_manage /etc/pandora/pandora_server.conf --start_snmptrapd

Graphs

create_custom_graph

Parameters: <name> <description> <user> <id_group> <width> <height> <events> <graph_type> <period> <modules> <separator>

Description: You can create a graph with these elements. Two or more modules must be separated with <separator> wich always must be specified, even for a single module. All parameters are required, but some of them can be empty by singles quotes. Their default values are:

  • Width: 550.
  • Height: 210.
  • Period: 86400 (seconds).
  • Events: 0.
  • Graph type: 0.
  • Id group: 0.

Example:

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>

Description: You can edit a graph with these values. All parameters are required, but some of them can be empty by singles quotes. Fields not specified keep their values.

Example:

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>

Description: These modules will be added to the graph. All parameters are required.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_modules_to_graph 2 '1015,1017' ','

delete_modules_to_graph

Parameters: <id_graph> <modules> <separator>

Description: These modules will be removed to the graph. All parameters are required.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf –delete_modules_to_graph 2 '1015,1017' ','

Clusters

new_cluster

Parameters: <cluster_name> <cluster_type> <description> <group_id>

Description: A cluster with the specified parameters and their associated elements will be created.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --new_cluster cluster1 AA description 12

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

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.

Example :

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_cluster_agent W3siaWQiOjUsImlkX2FnZW50IjoyfSwKeyJpZCI6NSwiaWRfYWdlbnQiOjN9XQ ===

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

add_cluster_item (active / active)

Parameters:

JSON data with this fields:

  • name : (string value).
  • id_cluster : (numeric value).
  • type : AA (means “Active/Active”).
  • critical_limit : (numeric value).
  • warning_limit : (numeric value).

Example JSON:

[
  {
    "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 JSON data is encoded on base 64.


Example :

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_cluster_agent WwogIHsKICAgICJuYW1lIjogIlN3YXBfVXNlZCIsCiAgICAiaWRfY2x1c3RlciI6IDUsCiAgICAidHlwZSI6ICJBQSIsCiAgICAiY3JpdGljYWxfbGltaXQiOiA4MCwKICAgICJ3YXJuaW5nX2xpbWl0IjogNjAKICB9LAogIHsKICAgICJuYW1lIjogIlRDUF9Db25uZWN0aW9ucyIsCiAgICAiaWRfY2x1c3RlciI6IDUsCiAgICAidHlwZSI6ICJBQSIsCiAgICAiY3JpdGljYWxfbGltaXQiOiA4MCwKICAgICJ3YXJuaW5nX2xpbWl0IjogNjAKICB9Cl0=

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

add_cluster_item (active / pasive)

Parameters:

JSON data with this fields:

  • name : (string value).
  • id_cluster : (numeric value).
  • type : AP (means “Active/Pasive”).
  • critical_limit : (numeric value).
  • warning_limit : (numeric value).

Example JSON:

[
  {
    "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 JSON data is encoded on base 64.


Example :

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_cluster_item WwogIHsKICAgICJuYW1lIjogIkRpc2tVc2VkXy9wcm9jL2tjb3JlIiwKICAgICJpZF9jbHVzdGVyIjogNSwKICAgICJ0eXBlIjogIkFQIiwKICAgICJpc19jcml0aWNhbCI6IDEKICB9LAogIHsKICAgICJuYW1lIjogIkRpc2tVc2VkXy9wcm9jL3NjaGVkX2RlYnVnIiwKICAgICJpZF9jbHVzdGVyIjogNSwKICAgICJ0eXBlIjogIkFQIiwKICAgICJpc19jcml0aWNhbCI6IDEKICB9Cl0=

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

get_cluster_status

Parameters: <id_cluster>

Description: Getting cluster status.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_cluster_status 7

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

delete_cluster

Parameters: <cluster_id>

Description: A cluster will be deleted.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_cluster 1

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

delete_cluster_agent

Parameters: <agent_id> <cluster_id>

Description: An agent added to a cluster will be disassociated

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_cluster_agent 1 1

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

delete_cluster_item

Parameters: <item_id>

Description: A cluster item will be deleted

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_cluster_item 1

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

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.

“Interesting data:” The mode can adopt the values'static_objects' and'auto_creation', in the first way the elements will be created without taking into account the position where to place the elements, but the position described in the elements json itself will be used. However, if the mode is 'auto_creation' a coordinate tapestry ('position_to_locate_elements' field with the format described in the example below) must be set and the algorithm will automatically establish the position and size of each of the elements.

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"}]'

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"}]'

edit_visual_console

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.

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"}]'

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"}]'

delete_visual_console

Parameters: <id>

Description: The specified visual console and its associated elements will be removed.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_visual_console 1

delete_visual_console_objects

Parameters: <id> <mode> <id_mode>

Description: Items associated with a visual console will be removed by following a filter. The available modes are “type”, “image”, “id_agent”, “id_agente_modulo”, “id_group” and “type_graph” where its identifier must be specified, which may be the type ID, the image name, the agent ID, the module ID, the group ID or the type of graphic. (area, line…).

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_visual_console_objects 1 'id_agent' 1

duplicate_visual_console

Parameters: <id> <times> [<prefix]

Description: The indicated visual console will be duplicated as many times as desired.

Example:

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>]

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.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --export_json_visual_console 1 '/tmp' 1

Others

locate_agent

Enterprise versionParameters: <agent_name> [ use_alias ] .

Description: Return the id of the node that manages the agent.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --locate_agent NAS

create_tag

Parameters: <tag_name> <tag_description> [ <tag_url> ] [ <tag_email> ]

Description: Create a new tag. Tag name and tag description are obligatory.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_tag 'New tag name' 'Your description'

For it to be carried out correctly, the API configuration parameters will need to be filled in pandora_server.conf (configuration file elements) : console_api_pass , console_pass , console_user y console_api_url .

Go back to Pandora FMS documentation index