Pandora: Documentation es: Anexo CLI

From Pandora FMS Wiki
Jump to: navigation, search

Volver a Indice de Documentacion Pandora FMS

Contents

1 CLI de Pandora FMS

La CLI (Command-Line Interface o Interfaz de Línea de Comandos) de Pandora FMS se utiliza haciendo llamadas en línea de comandos sobre el fichero /util/pandora_manage.pl. Este método es especialmente útil para integrar aplicaciones de terceros con Pandora FMS mediante tareas automatizadas. Básicamente consiste en un llamada con los parámetros formateados para realizar una acción como la creación y eliminación de un agente, un módulo o un usuario, entre otras.

El CLI es un fichero en Perl, por lo que una llamada al CLI es tan fácil como:

perl pandora_manage.pl <ruta de pandora_server.conf> <opción> <parámetros de esa opción>

Template warning.png

Si es un usuario enterprise, deberá utilizar el binario ejecutable en lugar del archivo .pl, debido a que ciertas funcionalidades enterprise podrían no funcionar correctamente con el fichero tipo .pl. Puede ejecutar directamente pandora_manage para comenzar.

 


Solo Enterprise:

pandora_manage <pandora_server.conf path> <option> <option parameters>


El CLI de Pandora FMS dispone de las siguientes opciones:

  • Agentes
    • --create_agent: Crear un agente
    • --update_agent: Actualizar un campo de un agente
    • --delete_agent: Eliminar un agente
    • --disable_group: Desactivar los agentes de todo un grupo
    • --enable_group: Activar los agentes de todo un grupo
    • --create_group: Crear un grupo nuevo
    • --delete_group: Borra un grupo
    • --update_group: Modifica un grupo
    • --stop_downtime: Detiene una desconexión programada
    • --get_agent_group: Obtener el nombre del grupo de un agente
    • --get_agent_modules: Obtener la lista de módulos de un agente
    • --get_agents: Obtener la lista de agentes de acuerdo a unos parametros
    • --delete_conf_file: Borrar el fichero de configuración de un agente
    • --clean_conf_file: Limpiar el fichero de configuración de un agente eliminando todos los módulos, políticas y colecciones
    • --get_bad_conf_files: Obtener los ficheros mal configurados (sin los tokens principales)
  • Módulos
    • --create_data_module: Añadir un módulo de datos a un agente
    • --create_web_module: Añadir un módulo web a un agente
    • --create_network_module: Añadir un módulo de red a un agente
    • --create_snmp_module: Añadir un módulo SNMP a un agente
    • --create_plugin_module: Añadir un módulo de tipo plugin a un agente
    • --create_module_group: Añadir un grupo de módulos
    • --delete_module: Eliminar un módulo de un agente
    • --data_module: Insertar datos a un módulo
    • --get_module_data: Muestra los datos de un módulo en los últimos X segundos (interval) en formato CSV
    • --get_module_id: Muestra la id de un modulo
    • --delete_data Eliminar el histórico de datos de un módulo, de los módulos de un agente o de los módulos de los agentes de un grupo
    • --update_module: Actualizar un campo de un módulo
  • Alertas
    • --create_template_module: Añadir una plantilla de alerta a un agente
    • --delete_template_module: Eliminar una plantilla de alerta de un agente
    • --create_template_action: Añadir una acción a una alerta
    • --delete_template_action: Eliminar una acción de una alerta
    • --disable_alerts: Desactivar las alertas en todos los grupos
    • --enable_alerts: Activar las alertas en todos los grupos
    • --create_alert_template: Crear una plantilla de alerta
    • --delete_alert_template: Eliminar una plantilla de alerta
    • --update_alert_template: Actualizar un campo de una plantilla de alerta
    • --validate_all_alerts: Validar todas las alertas
  • Usuarios
    • --create_user: Crear un usuario
    • --delete_user: Eliminar un usuario
    • --update_user: Actualizar un campo de un usuario
    • --enable_user: Activar un usuario dado
    • --disable_user: Desactivar un usuario dado
    • --create_profile: Crear un perfil nuevo
    • --add_profile: Añadir un perfil a un usuario
    • --delete_profile: Eliminar un perfil de un usuario
    • --add_profile_to_user: Añadir un perfil a un usuario en un grupo
    • --disable_eacl: Desactivar el sistema ACL enterprise
    • --enable_eacl: Activar el sistema ACL enterprise
  • Eventos
    • --create_event: Crear un evento
    • --validate_event: Validar un evento
    • --validate_event_id: Validar un evento dado su identificador.
    • --get_event_info: Mostrar información sobre un evento dado su identificador.
  • Incidentes
    • --create_incident Crear un incidente
  • Políticas
    • --create_policy: Crea una política nueva
    • --apply_policy Fuerza el aplicado de una política
    • --apply_all_policies: Añade a la cola de aplicación de políticas todas las políticas
    • --add_agent_to_policy: Añadir un agente a una política
    • --add_collection_to_policy: Añade una colección a una política
    • --create_policy_data_module_from_local_component: Crea un módulo de datos a partir de un componente local para una política determinada
    • --create_policy_web_module_from_local_component: Crea un módulo web a partir de un componente local para una política determinada
    • --delete_not_policy_modules Eliminar todos los módulos no asociados a ninguna política del archivo de configuración
    • --disable_policy_alerts: Desactivar las alertas de una política
    • --create_policy_data_module: Crear un modulo de datos en una política
    • --create_policy_web_module: Crear un modulo web en una política
    • --create_policy_network_module: Crear un modulo de datos en una política
    • --create_policy_snmp_module: Crear un modulo de tipo SNMP en una política
    • --create_policy_plugin_module: Crear un modulo de tipo plugin en una política
    • --validate_policy_alerts: Validar todas las alertas de una política
    • --get_policy_modules: Obtener la lista de módulos de una política
    • --get_policies: Obtener todas las políticas (sin parámetros) o las políticas de un agente (con su nombre como parámetro)
  • Herramientas
    • --exec_from_file: Ejecuta cualquier opción del CLI usando macros desde un fichero CSV

1.1 Agentes

1.1.1 Create_agent

Parámetros: <nombre_agente> <sistema_operativo> <nombre_grupo> <nombre_servidor> [<direccion> <descripcion> <intervalo>]

Descripción: Se creará un agente con el nombre, el sistema operativo, el grupo y el servidor especificados. Opcionalmente se le podrá otorgar una dirección (IP o nombre), una descipción y un intervalo en segundos (por defecto 300).

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_agent 'Mi agente' Windows Databases Central-Server 192.168.12.123 'Descripción del agente' 600

1.1.2 Update_agent

(>=5.0)

Parámetros: <agent_name> <field> <new_value>

Descripción: Se actualizará un campo dado de un agente existente. Los campos posibles son: agent_name, address, description, group_name, interval, os_name, disabled, parent_name, cascade_protection, icon_path, update_gis_data, custom_id.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_agent 'Nombre de agente' group_name 'Network'

1.1.3 Delete_agent

Parámetros: <nombre_agente>

Descripción: Se eliminará el agente pasado como parámetro su nombre.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_agent 'Mi agente'

1.1.4 Disable_group

Parámetros: <nombre_grupo>

Descripción: Los agentes del grupo pasado como parámetro serán desactivados con la ejecución de esta opción. Si se pasa 'All' como grupo se desactivarán todos los agentes de todos los grupos.

Ejemplo:

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

1.1.5 Enable_group

Parámetros: <nombre_grupo>

Descripción: Los agentes del grupo pasado como parámetro serán activados con la ejecución de esta opción. Si se pasa 'All' como grupo se activarán todos los agentes de todos los grupos.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_group All

1.1.6 Create_group

Parámetros: <group_name> [<parent_group_name> <icon> <description>]

Descripción: Se creará un grupo si ya no existe y opcionalmente se le podrá asignar un grupo padre y un icono (el nombre del icono sin extensión). El grupo padre por defecto es 'All' y el icono es cadena vacía (sin icono).


Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_group 'Nuevo grupo' 'Grupo padre' 'computer'

1.1.7 Delete_group

Parámetros: <group_name>

Descripción: Se borra el grupo que tenga dicho nombre.


Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_group 'Nuevo grupo'

1.1.8 Update_group

Parámetros: <group_id> [<group_name> <parent_group_name> <icon> <description>]

Descripción: Se modificara un grupo si existe la id pasada(Se puede utilizar la función "Get_agent_group_id" para saber la id del grupo) Los parámetros que se podrán modificar son el nombre, el padre al que apunta, el icono y su descripción.


Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_group 18 'Prueba2' 'Web' 'SpiderMan' 'Descripcion'

1.1.9 Stop_downtime

(>=5.0)

Parameters: <downtime_name>

Description: Detiene una desconexión programada. Si la desconexión ya terminó se mostrará un mensaje.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --stop_downtime 'Nombre desconexión'

1.1.10 Get_agent_group

(>=5.0)

Parámetros: <agent_name>

Descripción: Obtener el nombre del grupo de un agente

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agent_group 'Nombre agente'

1.1.11 Get_agent_group_id

(>=5.1)

Parámetros: <agent_name>

Descripción: Obtener el id del grupo de un agente

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agent_group 'Nombre agente'

1.1.12 Get_agent_modules

(>=5.0)

Parámetros: <agent_name>

Descripción: Obtener la lista de módulos (id y nombre) de un agente

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agent_modules 'Nombre agente'

1.1.13 Get_agents

(>=5.0)

Parámetros: [<group_name> <os_name> <status> <max_modules> <filter_substring> <policy_name>]

Descripción: Obtener todos los agentes (sin parámetros) o los agentes de acuerdo a un filtro

Valores posibles para el parámetro <status>: critical, warning, unknown, normal

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agents 'Network' 'Linux' 'critical'   'Nombre política'

1.1.14 Delete_conf_file

(>=5.0)

Parámetros: <agent_name>

Descripción: Se eliminará el fichero de configuración de un agente

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_conf_file 'Nombre de agente'

1.1.15 Clean_conf_file

(>=5.0)

Parámetros: [<agent_name>]

Descripción: Se limpiará el fichero de configuración de un agente o el de todos si no se pasan parámetros (Se eliminarán módulos, políticas, colecciones de ficheros y todos los comentarios).

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --clean_conf_file 'Nombre de agente'

1.1.16 Get_bad_conf_files

(>=5.0)

Parametrizes: No

Descripción: Se listarán los ficheros de configuración mal configurados (sin los tokens principales: server_ip,server_path,temporal,logfile)

Ejemplo:

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


1.1.17 create_downtime

(>=5.1)

Parametrizes: <downtime_name> <description> <date_from> <date_to> <id_group> <monday> <tuesday><wednesday> <thursday> <friday> <saturday> <sunday> <periodically_time_from><periodically_time_to> <periodically_day_from> <periodically_day_to><type_downtime> <type_execution> <type_periodicity>

Descripción: Se creara una parada planificada con los datos enviados. Para que se realice correctamente se necesitará que estén rellenos los parametros de configuración de la API en pandora_server.conf.

Ejemplo:

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


1.1.18 add_item_planned_downtime

(>=5.1)

Parametrizes: <id_downtime> <id_agente1,id_agente2,id_agente3...id_agenteN> <name_module1,name_module2,name_module3...name_moduleN>

Descripción: Se añadirán registros a una parada planificada con los datos enviados. Para que se realice correctamente se necesitará que estén rellenos los parametros de configuración de la API en pandora_server.conf.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_item_downtime 1 1 'Status','AvailableMemory'


1.1.19 get_all_planned_downtimes

(>=5.1)

Parametrizes: <name> [<id_group> <type_downtime> <type_execution> <type_periodicity>]

Descripción: Se listara todos los registros que coincidan con los datos enviados.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_all_planned_downtimes testing 0

1.1.20 planned_downtimes_items

(>=5.1)

Parametrizes: <name> [<id_group> <type_downtime> <type_execution> <type_periodicity>]

Descripción: Se listara todos los registros que coincidan con los datos enviados.

Ejemplo: perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_planned_downtimes_items testing 0


1.1.21 set_planned_downtimes_deleted

(>=5.1)

Parametrizes: <name>

Descripción: Se eliminará el registro. Si se está ejecutando está eliminación no se ejecutará.

Ejemplo: perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_planned_downtimes_deleted test

1.2 Modulos

1.2.1 Create_data_module

Parámetros: <nombre_modulo> <tipo_modulo> <nombre_agente> [<descripcion> <grupo_modulo> <min> <max> <post_process> <intervalo> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <fichero_definicion> <enable_unknown_events> <ff_threshold> <each_ff> <ff_threshold_normal> <ff_threshold_warning> <ff_threshold_critical> <ff_timeout> <critical_instructions> <warning_instructions> <unknown_instructions>]

Descripción: Se creará un módulo de tipo data en un agente con el nombre del módulo, tipo de módulo y nombre del agente donde se creará. Opcionalmente se le podrá otorgar una descripción, el grupo del módulo, unos valores min y max, un valor post_process, un intervalo en segundos, unos valores warning min y max, unos valores critical min y max, un valor history data y un fichero de definición del módulo.

El fichero de definición del módulo contendrá algo de este estilo:

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

Los valores por defecto son 0 para los minimos y máximos, history_data y post_process y 300 para el intervalo.

Notas:

Los siguientes parámetros son solo a partir de la versión 5 de Pandora:

  • <enable_unknown_events>

Los siguientes parámetros son solo a partir de la versión 5.1 de Pandora:

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

Los siguientes parámetros son solo a partir de la versión 6 de Pandora:

  • <warning_inverse>
  • <critical_inverse>

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_data_module 'Mi modulo' generic_data 'Mi agente' 'Descripcion del modulo' 'General' 1 3 0 300 0 0 0 0 1 /home/user/ficherodefinicion

Si se introduce un nombre o tipo diferente entre los parámetros y la definición del fichero, tendrá prioridad lo establecido en el fichero.

1.2.2 Create_web_module

Parámetros: <nombre_modulo> <tipo_modulo> <nombre_agente> [<descripcion> <grupo_modulo> <min> <max> <post_process> <intervalo> <warning_min> <warning_max> <critical_min> <critical_max> <history_data> <fichero_definicion> <enable_unknown_events> <ff_threshold> <each_ff> <ff_threshold_normal> <ff_threshold_warning> <ff_threshold_critical> <ff_timeout> <critical_instructions> <warning_instructions> <unknown_instructions>]

Descripción: Se creará un módulo de tipo web en un agente con el nombre del módulo, tipo de módulo y nombre del agente donde se creará. Opcionalmente se le podrá otorgar una descripción, el grupo del módulo, unos valores min y max, un valor post_process, un intervalo en segundos, unos valores warning min y max, unos valores critical min y max, un valor history data y un fichero de definición del módulo.

El fichero de definición del módulo contendrá algo de este estilo:

task_begin
get http://pandorafms.com
task_end

Los valores por defecto son 0 para los minimos y máximos, history_data y post_process y 300 para el intervalo.

Notas:

Los siguientes parámetros son solo a partir de la versión 6 de Pandora:

  • <enable_unknown_events>

Los siguientes parámetros son solo a partir de la versión 6.1 de Pandora:

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

Los siguientes parámetros son solo a partir de la versión 6 de Pandora:

  • <warning_inverse>
  • <critical_inverse>

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_web_module 'Mi modulo' web_data 'Mi agente' 'Descripcion del modulo' 'General' 1 3 0 300 0 0 0 0 1 /home/user/ficherodefinicion

Si se introduce un nombre o tipo diferente entre los parámetros y la definición del fichero, tendrá prioridad lo establecido en el fichero.

1.2.3 Create_network_module

Parámetros: <nombre_modulo> <tipo_modulo> <nombre_agente> <direccion_modulo> [<puerto_modulo> <descripcion> <grupo_modulo> <min> <max> <post_process> <intervalo> <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>]

Descripción: Se creará un módulo de red en un agente con el nombre del módulo, tipo de módulo, nombre del agente donde se creará y la dirección del módulo especificados. Opcionalmente se le podrá otorgar un puerto, una descripción, unos valores min y max, un valor post_process, un intervalo en segundos, unos valores warning min y max, unos valores critical min y max, y un valor history data.

Los valores por defecto son 0 para los minimos y máximos, history_data y post_process y 300 para el intervalo.

El puerto es optativo ya que lo módulos de tipo ICMP no precisan de él. En el resto de tipos si que es necesario especificar un módulo.

Notas:

Los siguientes parámetros son solo a partir de la versión 5 de Pandora:

  • <enable_unknown_events>

Los siguientes parámetros son solo a partir de la versión 5.1 de Pandora:

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

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_network_module 'Mi modulo' remote_tcp 'Mi agente' 192.168.12.123 8080 'Descripcion del modulo' 'General' 1 3 0 300 0 0 0 0 1

1.2.4 Create_snmp_module

Parámetros: <nombre_modulo> <tipo_modulo> <nombre_agente> <direccion_modulo> <puerto_modulo> <version> [<community> <oid> <descripcion> <grupo_modulo> <min> <max> <post_process> <intervalo> <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_treshold_warning> <ff_threshold_critical> <critical_instructions> <warning_instructions> <unknown_instructions>]

Descripción: Se creará un módulo de tipo snmp en un agente con el nombre del módulo, tipo de módulo, nombre del agente donde se creará, la dirección del módulo, el puerto asociado y la versión de SNMP especificados. Opcionalmente se le podrá suministrar una community, una OID, una descripción, el grupo del módulo, unos valores min y max, un valor post_process, un intervalo en segundos, unos valores warning min y max, unos valores critical min y max, un valor history data y los parámetros de snmp3 tales como métodos, passwords, etc.

Los valores por defecto son 0 para los minimos y máximos, history_data y post_process y 300 para el intervalo.

Notas:

Los siguientes parámetros son solo a partir de la versión 5 de Pandora:

  • <enable_unknown_events>

Los siguientes parámetros son solo a partir de la versión 5.1 de Pandora:

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

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_snmp_module 'Mi modulo' remote_snmp_inc 'Mi agente' 192.168.12.123 8080 1 mycommunity myoid 'Descripcion del modulo'

1.2.5 Create_plugin_module

Parámetros: <nombre_modulo> <tipo_modulo> <nombre_agente> <direccion_modulo> <puerto_modulo> <nombre_plugin> <usuario> <password> <parametros> [<descripcion> <grupo_modulo> <min> <max> <post_process> <intervalo> <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>]

Descripción: Se creará un módulo de tipo plugin en un agente con el nombre del módulo, tipo de módulo, nombre del agente donde se creará, la dirección del módulo, el puerto asociado y nombre de plugin correspondiente. Opcionalmente se le podrá suministrar una descripción, el grupo del módulo, unos valores min y max, un valor post_process, un intervalo en segundos, unos valores warning min y max, unos valores critical min y max, y un valor history data.

Los valores por defecto son 0 para los minimos y máximos, history_data y post_process y 300 para el intervalo.

Notas:

Los siguientes parámetros son solo a partir de la versión 5 de Pandora:

  • <enable_unknown_events>

Los siguientes parámetros son solo a partir de la versión 5.1 de Pandora:

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

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_plugin_module 'Mi modulo' generic_data 'Mi agente' 192.168.12.123 8080 myplugin myuser mypass 'param1 param2 param3' 'Descripcion del modulo' 'General' 1 3 0 300 0 0 0 0 1

1.2.6 Create_module_group

Parámetros: <nombre_del_grupo>

Descripción: Se creará un grupo de módulos con el nombre especificado.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_module_group 'Nombre del grupo'


1.2.7 Create_synthetic

Parámetros: <nombre_modulo> <tipo_sintético> <nombre_agente> <opts>

Donde <tipo_sintético> puede ser "arithmetic" o "average".

Ejemplos

pandora_manage /etc/pandora/pandora_server.conf --create_synthetic modulo_ejemplo arithmetic agente_ejemplo <opts>
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic modulo_ejemplo average agente_ejemplo <opts>

Explicamos los posibles parámetros que pueden utilizarse en la parte <opts>:

  • <opts> = <agente_origen1>,<operando>,<modulo_origen1> <agente_origen2>,<operando>,<modulo_origen2>
  • <opts> = <agente_origen1>,<operando>,<modulo_origen1> <operando>,<valor_fijo>

Ejemplos

pandora_manage /etc/pandora/pandora_server.conf --create_synthetic modulo_ejemplo arithmetic agente_ejemplo mi_agente,+,mi_modulo mi_agente2,-,mi_modulo2
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic modulo_ejemplo arithmetic agente_ejemplo mi_agente,+,mi_modulo *,10
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic modulo_ejemplo average agente_ejemplo mi_agente,x,mi_modulo mi_agente,x,mi_modulo2

En el primer ejemplo, se creará en el agente agente_ejemplo un módulo con nombre modulo_ejemplo de tipo aritmético, su contenido será el resultado de la resta de mi_modulo - mi_modulo2 En el segundo ejemplo, se creará en el agente agente_ejemplo un módulo con nombre modulo_ejemplo de tipo aritmético, su contenido será el resultado de la multiplicación de mi_modulo * 10.

El primer operando que se utiliza, en el caso anterior entre mi_agente y mi_modulo (+), no se tiene en cuenta para las operaciones, pero por funcionamiento de la herramienta es necesario introducirlo, es importante tener en cuenta que la operación aritmética se hará teniendo en cuenta el siguiente operando, en este caso entre mi_agente2 y mi_modulo2, o justo antes del valor 10 (en este caso, los operadores "-" o "*"). Los posibles operandos son:

  • + suma
  • - resta
  • * multiplicación
  • / división
  • x media. Este operando solo podrá utilizarse con el tipo de módulo average.

Descripción: Se creará un módulo sintético en el agente y con el nombre de módulo indicados, El tipo de módulo puede ser arithmetic (aritmética) o average (promedio). Los operandos pueden ser: +, -, *, / o x.


Notas:

Disponible a partir de Pandora 5.1 SP4

Ejemplos:

pandora_manage /etc/pandora/pandora_server.conf --create_synthetic suma_memoria arithmetic nodo51sp3 production1,+,AvailableMemory production2,+,AvailableMemory
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic diferencia_trafico arithmetic nodo51sp3 nodo51sp3,+,InputTraffic nodo51sp3,-,OutputTraffic

1.2.8 Delete_module

Parámetros: <nombre_modulo> <nombre_agente>

Descripción: Se eliminará un módulo de un agente pasados el nombre de ambos como parámetro. En el caso de que este módulo esté en un agente local, también será eliminado del fichero de configuración si se dispone de la versión Enterprise.

Ejemplo:

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

1.2.9 Data_module

Parámetros: <nombre_servidor> <nombre_agente> <nombre_modulo> <tipo_modulo> <nuevo_dato> [<fechahora>]

Descripción: Se mandarán datos a un módulo de un agente pasándole como parámetro el nombre del servidor, del agente, del módulo, el tipo de módulo y el dato a introducir. De forma optativa se podrá enviar la fecha-hora que figurará como de envío de los datos con formato 24 horas: 'YYY-MM-DD HH:mm'. En el caso de no enviar este parámetro figurará la fecha actual.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --data_module Servidor-General 'Mi agente' 'Mi modulo' 'generic_data' 1 '2010-05-31 15:53'

1.2.10 Get_module_data

(>=5.0)

Parametros: <nombre_agente> <nombre_modulo> <intervalo> [<separador_csv>]

Descripción: Se devolverán los datos de un módulo como 'timestamp dato' en formato CSV de los últimos X segundos (intervalo) usando como separador por defecto ';'

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_data 'nombre agente' 'nombre modulo' 86400 ':'


1.2.11 Get_module_id

Parametros: <agent_id> <module_name>

Descripción: Se devolverá la id de un modulo concreto de un agente.

Ejemplo:

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

1.2.12 Delete_data

Parámetros: <nombre_modulo> <nombre_agente> | -a <nombre_agente> | -g <nombre_grupo>

Descripción: Se eliminará del histórico de datos todos los datos asociados a un módulo en el caso de pasar como parámetro la opción -m y el nombre de éste junto al de su agente; de los módulos de un agente, si como parámetro se pasa la opción '-a' y el nombre de un agente o de los módulos de todos los agentes de un grupo, si como parámetro se pasa la opción '-g' y el nombre de un grupo.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_data -a 'Mi agente'

En este ejemplo se eliminarían los datos históricos de todos los módulos pertenecientes al agente 'Mi agente'.

1.2.13 Update_module

Parámetros: <module_name> <agent_name> <field_to_update> <new_value>

Descripción: Se actualizará un campo dado de un módulo existente. Se detectará el tipo de módulo para permitir actualizar los campos específicos de cada tipo.

Los campos posibles son:

  • Comunes a cualquier módulo: 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, critical_instructions, warning_instructions, unknown_instructions
  • Para los módulos de datos: ff_timeout
  • Para los módulos de red: module_address, module_port
  • Para los módulos de tipo SNMP: 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
  • Para los módulos de tipo plugin: module_address, module_port, plugin_name, user, password, parameters

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_module 'Nombre del módulo' 'Nombre del agente' description 'Nueva descripción'

1.2.14 Get_agents_module_current_data

(>=5.0)

Parámetros: <module_name>

Descripción: Obtener el agente y el dato actual de todos los módulos con un nombre dado

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agents_module_current_data 'Nombre módulo'

1.2.15 Create_network_module_from_component

(>=5.0)

Parámetros: <agent_name> <component_name>

Descripción: Crear un nuevo módulo de red en el agente especificado desde el componente de red.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_network_module_from_component 'Nombre agente'


1.2.16 Create_data_module_from_local_component

(>=5.1)

Parámetros: <agent_name> <component_name>

Descripción: Crear un nuevo módulo de datos en el agente especificado desde el componente local.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_data_module_from_local_component 'Nombre agente' 'Mi componente local'

1.2.17 Create_web_module_from_local_component

(>=6.1)

Parámetros: <agent_name> <component_name>

Descripción: Crear un nuevo módulo web en el agente especificado desde el componente local.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_web_module_from_local_component 'Nombre agente' 'Mi componente local'

1.2.18 Create_local_component

(>=5.1)

Parámetros: <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>]

Descripción: Crear un nuevo componente local.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_local_component 'Nuevo componente local' 'module_begin\nmodule_name name\nmodule_type generic_data\nmodule_exec exec\nmodule_end'

1.3 Alertas

1.3.1 Create_template_module

Parámetros: <nombre_plantilla> <nombre_modulo> <nombre_agente>

Descripción: Se asignará una plantilla a un módulo de un agente pasándole el nombre de la plantilla, el módulo y el agente como parámetro.

Ejemplo:

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

1.3.2 Delete_template_module

Parámetros: <nombre_plantilla> <nombre_modulo> <nombre_agente>

Descripción: Se desasignará una plantilla de un módulo de un agente pasándole el nombre de la plantilla, el módulo y el agente como parámetro.

Ejemplo:

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

1.3.3 Create_template_action

Parámetros: <nombre_accion> <nombre_plantilla> <nombre_modulo> <nombre_agente> [<fires_min> <fires_max>]

Descripción: Se añadirá una acción a una alerta pasando como parámetros el nombre de la acción y el de la plantilla, módulo y agente que conforman la alerta. También se le podrán pasar de forma optativa los valores de escalado fires_min y fires_max (por defecto 0).

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_template_action acción012 plantilla001 'Mi modulo' 'Mi agente' 0 4

1.3.4 Delete_template_action

Parámetros: <nombre_accion> <nombre_plantilla> <nombre_modulo> <nombre_agente>

Descripción: Se añadirá una acción a una alerta pasando como parámetros el nombre de la acción y el de la plantilla, módulo y agente que conforman la alerta.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_template_action acción012 plantilla001 'Mi modulo' 'Mi agente'

1.3.5 Disable_alerts

Parámetros: No

Descripción: Todas las alertas serán desactivadas con la ejecución de esta opción. Si cuando se ejecuta tuvieramos alguna alerta desactivada y volvemos a activar todas, esta también será activada.

Ejemplo:

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

1.3.6 Enable_alerts

Parámetros: No

Descripción: Todas las alertas serán activadas con la ejecución de esta opción. Si cuando se ejecuta tuvieramos alguna alerta activada y volvemos a desactivar todas, esta también será desactivada.

Ejemplo:

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

1.3.7 Create_alert_template

Parámetros: <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>]

Descripción: Se creará una plantilla de alerta.

El campo <condition_type_serialized> son las opciones de tipo de plantilla serializadas con el separador ';' por defecto. Se puede cambiar el separador con el parámetro <condition_type_separator> para evitar conflictos en algunas opciones is existiera la posibilidad de que contuviesen el caracter por defecto.

Las posibilidades son las siguientes:

NOTA: En estos ejemplos es usado el separador por defecto ';' y el campo matches_value es un valor binario para establecer si la alerta se disparará cuando el valor coincida o no con las condiciones.

  • Expresión regular:
    • Sintaxis: <type>;<matches_value>;<value>
    • Ejemplo: regex;1;stopped|error (Alerta cuando el valor coincida con la expresión regular 'stopped|error')
  • Máx. y mín.:
    • Sintaxis: <type>;<matches_value>;<min_value>;<max_value>
    • Ejemplo: max_min;0;30;50 (Alerta cuando el valor está fuera del intervalo 30-50)
  • Máx.:
    • Sintaxis: <type>;<max_value>
    • Ejemplo: max;70 (Alerta cuando el valor es mayor de 70)
  • Mín.:
    • Sintaxis: <type>;<min_value>
    • Ejemplo: min;30 (Alerta cuando el valor es menor de 30)
  • Igual a:
    • Sintaxis: <type>;<value>
    • Ejemplo: equal;0 (Alerta cuando el valor es igual a 0)
  • Diferente de:
    • Sintaxis: <type>;<value>
    • Ejemplo: not_equal;100 (Alerta cuando el valor es distinto de 100)
  • Estado advertencia:
    • Sintaxis: <type>
    • Ejemplo: warning (Alerta cuando el estado cambie a advertencia)
  • Estado crítico:
    • Sintaxis: <type>
    • Ejemplo: critical (Alerta cuando el estado cambie a crítico)
  • Estado desconocido:
    • Sintaxis: <type>
    • Ejemplo: unknown (Alerta cuando el estado cambie a desconocido)
  • En estado de cambio:
    • Sintaxis: <type>;<matches_value>
    • Ejemplo: onchange;1 (Alerta cuando el valor cambie)
  • Siempre:
    • Sintaxis: <type>
    • Ejemplo: always (Alerta siempre)

El campo <days> son siete caracteres binarios que especifican los días de la semana cuando la alerta estará activada. p.e.: 0000011 para activar la alerta solo Sábado y Domingo.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf.2011-10-25 --create_alert_template 'nombre de la plantilla' "[email protected]@[email protected]" 09:00 18:00 "Manda un email cuando el valor está en el intervalo 3-5, entra las 9AM y las 6PM, y solo los Lunes. El separador es forzado a @" "Unknown" "[email protected]" "asunto" "mensaje" 3 "Mail to XXX" 1000000 38600 1 2 0   @

1.3.8 Delete_alert_template

(>=5.0)

Parámetros: <template_name>

Descripción: Se eliminará una plantilla de alerta si existe.

Example:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_alert_template 'Nombre de plantilla'

1.3.9 Update_alert_template

(>=5.0)

Parámetros: <template_name> <field_to_update> <new_value>

Descripción: Se actualizará un campo dado de una plantilla de alerta existente. Los campos posibles son los siguientes: 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.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_alert_template 'Nombre de plantilla' priority 4

1.3.10 Validate_all_alerts

(>=5.0)

Parámetros: None

Descripción: Se validan todas las alertas.

Ejemplo:

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


1.3.11 Create_special_day

(>=5.1)

Parámetros: <special_day> <same_day> <description> <group_name>

Descripción: Crear un día especial. Los posibles same_day son: lunes, martes, miercoles, jueves, viernes, sabado y domingo.

Example:

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

1.3.12 Delete_special_day

(>=5.1)

Parámetros: <día_especial>

Descripción: Borrado del día especial especificado.

Example:

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


1.3.13 Update_special_day

(>=5.1)

Parámetros: <día_especial> <campo_a_cambiar> <nuevo_valor>

Descripción: Modificar un campo específico de un día especial. Los campos que se puede actualizar son: same_day, description y group_name. Los posibles valores para same_day son: lunes, martes, miercoles, jueves, viernes, sabado y domingo.

Example:

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

1.4 Usuarios

1.4.1 Create_user

Parámetros: <nombre_usuario> <contraseña> <es_admin> [<comentarios>]

Descripción: Se creará un usuario con el nombre y password recibidos como parámetro. Además se recibirá un valor binario que especifique si el usuario será o no administrador. De forma optativa se podrán enviar también comentarios a cerca del usuario creado.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_user usuario002 'renardo' 0 'Este usuario tiene como clave renardo'

1.4.2 Delete_user

Parámetros: <nombre_usuario>

Descripción: Se eliminará un usuario pasado su nombre como parámetro.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_user usuario002

1.4.3 Update_user

(>=5.0)

Parametros: <id_usuario> <campo_a_modificar> <nuevo_valor>

Descripción: Se actualizará un campo dado de un usuario existente. Los campos posibles son: email, phone, is_admin (0-1), language, id_skin, flash_chart (0-1), comments, fullname, password.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_user 'Id de usuario' password 'Nueva password'

1.4.4 Enable_user

(>=5.0)

Parametros: <id_usuario>

Descripción: Un usuario existente será activado. Si ya está activado, solamente se mostrará un mensaje

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_user 'Id de usuario'

1.4.5 Disable_user

(>=5.0)

Parametros: <id_usuario>

Descripción: Un usuario existente será desactivado. Si ya está desactivado, solamente se mostrará un mensaje

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_user 'Id de usuario'

1.4.6 Create_profile

Parámetros: <nombre_perfil> <ver_incidentes> <editar_incidentes> <gestionar_incidentes> <ver_agentes><editar_agentes> <desactivar_agentes> <editar_alertas> <gestionar_alertas> <gestionar_usuarios> <gestionar_bd><ver_eventos> <editar_eventos> <gestionar_eventos> <ver_informes> <editar_informes> <gestionar_informes> <ver_mapas> <editar_mapas> <gestionar_mapas> <ver_consolav> <editar_consolav> <gestionar_consolav><gestionar_pandora>

Descripción: Se creara un nuevo perfil pasandole como parámetros el nombre del perfil y los permisos. Todos los campos son obligatorios.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_profile 'perfilNuevo' 1 0 1 1 0 0 0 1 1 1 1 1 1 0 0 1 0 0 0 1 1 1 1


1.4.7 add_profile

Parámetros: <nombre_usuario> <nombre_perfil> <grupo>

Descripción: Se añadirá un perfil a un usuario pasándole como parámetro el nombre de usuario, el nombre del perfil y el nombre del grupo sobre el que tendrá los privilegios de ese perfil. Se especificará el grupo 'All' si se desea que el perfil tenga validez en todos los grupos.

Ejemplo:

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

1.4.8 Delete_profile

Parámetros: <nombre_usuario> <nombre_perfil> <grupo>

Descripción: Se eliminará un perfil de un usuario pasándole como parámetro el nombre de usuario, el nombre del perfil y el nombre del grupo sobre el que tiene los proivilegios el perfil. Si el perfil a eliminar está asociado al "grupo All" deberemos especificar como grupo "All".

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_profile usuario002 'Chief Operator' Applications

1.4.9 Add_profile_to_user

(>=5.0)

Parametros: <id_usuario> <nombre_perfil> [<nombre_grupo>]

Descripción: Se asignará un perfil a un usuario en un grupo existentes. Si no se proporciona grupo se asignará en el grupo 'All'.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_user 'Id de usuario' 'Chief Operator' 'Network'

1.4.10 Disable_aecl

Parámetros: No

Descripción: El sistema ACL del modo enterprise será desactivado en la configuración con la ejecución de esta opción.

Ejemplo:

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

1.4.11 Enable_aecl

Parámetros: No

Descripción: El sistema ACL del modo enterprise será activado en la configuración con la ejecución de esta opción.

Ejemplo:

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

1.4.12 Disable_double_auth

Parámetros: <id_usuario>

Descripción: Se desactivará la doble autenticación del usuario elegido.

Ejemplo:

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

1.5 Events

1.5.1 Create_event

Parámetros: <nombre_evento> <tipo_evento> <nombre_grupo> [<nombre_agente> <nombre_modulo> <estado_evento> <severity> <nombre_plantilla> <nombre_usuario> <comentario> <fuente> <id_extra> <tags> <datos_personalizados>]

Descripción: Se creará un evento con los datos nombre y tipo del evento, y nombre del modulo, agente y grupo asociados. Opcionalmente se podrá enviar

  • nombre del agente
  • nombre del módulo
  • estado del evento (0 si no está validado y 1 si lo está).
  • severidad: 0 (Mantenimiento), 1 (Informativo), 2 (Normal), 3 (Advertencia), 4 (Crítica).
    A partir de la versión 5.0 también hay 5 (Menor) y 6 (Mayor)
  • nombre de la plantilla en el caso de que esté asociado a una alerta.
  • nombre de usuario
  • comentario
  • fuente
  • id_extra
  • etiquetas: El formato de las etiquetas debe ser <etiqueta> <url>,<etiqueta> <url>
    Se pueden añadir varias etiquetas separadas por comas. Es importante que no haya espacios entre la coma y la siguiente etiqueta.
  • datos personalizados: Los datos personalizados se introducen como un documento JSON. Por ejemplo: '{"Location": "Office", "Priority": 42}'

El tipo de evento es un campo obligatorio y podrá tomar alguno de estos valores: 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.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_event ' Evento CLI' system Firewalls 'Mi agente' 'Mi modulo' 0 4 Plantilla004

1.5.2 Validate_event

Parámetros: <nombre_agente> <nombre_modulo> <fechahora_min> <fechahora_max> <nombre_usuario> <criticidad> <nombre_plantilla>

Descripción: Se validarán todos los eventos atendiendo a una serie de filtros. Los filtros configurables son el nombre del agente, el nombre del modulo, una fecha-hora mínima y una fecha-hora máxima, el nombre de usuario, la criticidad y el nombre de la plantilla asociada.

Se pueden combinar los parámetros de muchas maneras, dejando en blanco con comillas vacías ('') los que no se quieran utilizar y rellenando los demás.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_event 'Mi agente' 'Mi modulo' '' '2010-06-02 22:02'

En este ejemplo se validarían todos los eventos asociados al módulo 'Mi módulo' del agente 'Mi agente' cuya fecha sea inferior al 2 de junio de 2010 omitiendo el resto de filtros. Así mismo se podrían filtrar los eventos entre dos fechas rellenando ambas o los que tengan una fecha superior a una dada, rellenando solamente la fecha-hora mínima.

1.5.3 Validate_event_id

(>=5.0)

Parámetros: <id_evento>

Descripción: Se validará un evento dado su identificador.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_event_id 1894

En este ejemplo se validaría el evento cuyo identificador de evento (id_evento) es 1894.

1.5.4 Get_event_info

(>=5.0)

Parámetros: <id_evento>[<separador>]

Descripción: Se mostrará la información de un evento dado su identificador. Opcionalmente se le pasará un separador de campos. Por defecto, los campos se separan por |

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_event_info 1894

En este ejemplo se mostrará la información del evento cuyo identificador de evento (id_evento) es 1894 y se separarán los campos por |

1.5.5 Add_event_comment

(>=5.1)

Parámetros: <id_event> <user_name> <comment>

Descripción: Añadir comentario de evento.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_event_comment 1234 admin TEXT

En este ejemplo, el comentario 'TEXT' de 'admin' se añadirá al evento cuyo identificador es 1234.

1.6 Incidentes

1.6.1 Create_Incident

(>=5.0)

Parámetros: <title> <description> <origin> <status> <priority> <group> [<owner>]

Descripción: Se creará un incidente pasándole el título, la descripción, el origen, el estado, la prioridad, el grupo y opcionalmente, el propietario.

La prioridad será un número conforme a la siguiente correspondencia:

0: Informativo; 1: Baja; 2: Media; 3: Importante; 4: Muy importante; 5: Mantenimiento

El estado será un número conforme a la siguiente correspondencia:

0: Incidente activo; 1: Incidente activo con comentarios; 2: Incidente rechazado ; 3: Incidente expirado; 13: Incidente cerrado

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_incident 'Incident' 'Incident Description' 'Other data source' 3 2 'id_owner_user'

1.7 Policies

1.7.1 Create_policy

Parámetros: <nombre_política> <nombre_grupo> <descripción>

Descripción:Se creará una política con el nombre especificado, perteneciente al grupo también especificado y con la descripción como tercer parámetro, éste opcional.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy 'Mi politica' 'Web' 'Descripción personal'

1.7.2 Apply_all_policies

(>=5.0)

Parámetros: None

Descripción: Añade a la cola de aplicación todas las políticas. El servidor es quien observa la cola y aplica las políticas

Ejemplo:

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

1.7.3 Apply_policy

Parámetros: <nombre_política>

Descripción:Se aplicará de forma forzada una política pasada como parámetro. Dentro del proceso de aplicar una política está la de creación de los módulos de la política en todos sus agentes asociados, la creación de las alertas de la política en los módulos creados, y la realización de cambios en el fichero de configuración de los agentes locales que pueda tener la política para añadir los módulos creados y las colecciones asociadas a la política.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --apply_policy 'Mi politica'

1.7.4 Apply_all_policies

(>=5.0)

Parámetros: None

Descripción: Añade a la cola de aplicación todas las políticas. El servidor es quien observa la cola y aplica las políticas

Ejemplo:

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

1.7.5 Add_agent_to_policy

(>=5.0)

Parámetros: <nombre_agente> <nombre_politica>

Descripción: Se agregará un agente existente a una política existente

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_agent_to_policy 'Nombre agente' 'Nombre política'

1.7.6 Add_collection_to_policy

Parámetros: <nombre_politica> <nombre_coleccion>

Descripción: Se agregará una colección existente a una política existente

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_collection_to_policy 'Nombre política' 'Nombre colección'

1.7.7 Create policy data module from local component

Parámetros: <nombre_politica> <nombre_componente>

Descripción: Se agregará un módulo sacado de un componente local existente a una política existente

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_data_module_from_local_component 'Nombre política' 'Nombre componente'

1.7.8 Delete_not_policy_modules

Parámetros: No

Descripción: Se eliminarán, tanto de la base de datos como del fichero de configuración de los agentes (en caso de existir), todos los módulos que no pertenezcan a ninguna política.

Ejemplo:

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

1.7.9 Disable_policy_alerts

Parámetros: <nombre_política>

Descripción: Todas las alertas de una política pasada por parámetro serán marcadas como desactivadas

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_policy_alerts 'Mi politica'

1.7.10 Create_policy_data_module

(>=5.0)

Parámetros: <nombre_politica> <nombre_modulo> <tipo_modulo> [<descripcion> <grupo_modulo> <min> <max> <post_process> <intervalo> <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>]

Descripcion: Se creará un módulo de datos en una política. Los valores por defecto son los mismos que para la opción --create_data_module

Notas:

Los siguientes parámetros son solo a partir de la versión 5.1 de Pandora:

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

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_data_module 'nombre de la politica' 'nombre del modulo' generic_proc 'descripcion del modulo' 'nombre del grupo' 0 100 0 300 30 60 61 100 0 "module_begin\nmodule_name modname\nmodule_end" 'cadena para warning' 'cadena para critical'

1.7.11 Create_policy_web_module

(>=6.0)

Parámetros: <nombre_politica> <nombre_modulo> <tipo_modulo> [<descripcion> <grupo_modulo> <min> <max> <post_process> <intervalo> <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>]

Descripcion: Se creará un módulo web en una política. Los valores por defecto son los mismos que para la opción --create_web_module

Notas:

Los siguientes parámetros son solo a partir de la versión 6.1 de Pandora:

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

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_web_module 'nombre de la politica' 'nombre del modulo' web_proc 'descripcion del modulo' 'nombre del grupo' 0 100 0 300 30 60 61 100 0 "module_begin\nmodule_name modname\nmodule_end" 'cadena para warning' 'cadena para critical'

1.7.12 Create_policy_network_module

(>=5.0)

Parámetros: <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>]

Descripción: Se creará un módulo de red en una política. Los valores por defecto son los mismos que para la opción --create_network_module option

Notas:

Los siguientes parámetros son solo a partir de la versión 5.1 de Pandora:

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

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_network_module 'nombre de política' 'nombre de modulo' remote_icmp_proc 22 'descripcion de modulo' 'nombre del grupo' 0 100 0 300 30 60 61 100 0 0 'cadena para warning' 'cadena para critical'

1.7.13 Create_policy_snmp_module

(>=5.0)

Parámetros: <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>]

Descripción: Se creará un módulo SNMP en una política. Los valores por defecto son los mismos que para la opción --create_snmp_module option

Notas:

Los siguientes parámetros son solo a partir de la versión 5.1 de Pandora:

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

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_snmp_module 'nombre de política' 'nombre de módulo' remote_snmp_inc 8080 1 mycommunity myoid 'descripción de módulo'

1.7.14 Create_policy_plugin_module

(>=5.0)

Parámetros: <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>]

Descripción: Se creará un módulo de tipo plugin en una política. Los valores por defecto son los mismos que para la opción --create_plugin_module option

Notas:

Los siguientes parámetros son solo a partir de la versión 5.1 de Pandora:

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

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_policy_plugin_module 'nombre de política' 'nombre de módulo' generic_data 22 myplugin myuser mypass 'param1 param2 param3' 'Descripción de módulo' 'General' 1 3 0 300 0 0 0 0 1 'cadena para warning' 'cadena para critical'

1.7.15 Validate_policy_alerts

(>=5.0)

Parámetros: <policy_name>

Descripción: Se validan todas las alertas de una política dada

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_policy_alerts 'Nombre de política'

1.7.16 Get_policy_modules

(>=5.0)

Parámetros: <policy_name>

Descripción: Obtener la lista de módulos (id y nombre) de una política

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_policy_modules 'Nombre política'

1.7.17 Get_policies

(>=5.0)

Parámetros: [<agent_name>]

Descripción: Obtener todas las políticas (sin parámetros) o las políticas de un agente (con su nombre como parámetro)

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_policies 'Nombre de agente'

1.8 Netflow

1.8.1 Create_netflow_filter

(>=5.0)

Parámetros: <filter_name> <group_name> <filter> <aggregate_by> <output_format>

Descripción: Crear un nuevo filtro de netflow.

Los valores posibles del parámetro aggregate_by son: dstip,dstport,none,proto,srcip,srcport Los valores posibles del parámetro output_format son: kilobytes,kilobytespersecond,megabytes,megabytespersecond

Example:

Para crear un filtro de netflow ejecutaremos la siguiente opción:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_netflow_filter "Nombre del filtro" Network "host 192.168.50.3 OR host 192.168.50.4 or HOST 192.168.50.6" dstport kilobytes

1.9 Herramientas

1.9.1 Exec_from_file

(>=5.0)

Parámetros: <file_path> <option_to_execute> <option_params>

Descripciónn: Con esa opción es posible ejecutar cualquier opción del CLI con macros desde un fichero CSV. El número de macros corresponderá con el número de columnas en el fichero CSV. Cada macro será llamada __FIELD1__ , __FIELD2__ , __FIELD3__ etc.

Ejemplo: Vamos a crear usuarios desde un fichero CSV.

Necesitamos un fichero CSV como éste:

Usuario 1,Password 1,0
Usuario 2,Password 2,0
Usuario 3,Password 3,0
Usuario Admin,Password Admin,1

El nombre del fichero será '/tmp/users_csv'

Ejecutaremos la opción --create_user con las siguientes opciones: <user_name> <user_password> <is_admin> <comments>

Para hacer esto, ejecutaremos lo siguiente:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --exec_from_file /tmp/users_csv create_user __FIELD1__ __FIELD2__ __FIELD3__ 'Usuario creado con la opción exec_from_file desde el CLI'

NOTA: Las comas en las columnas CSV no están soportadas aún


1.9.2 create_snmp_trap

(>=5.0)

Parámetros: <file_path> <nombre> <oid> <descripción> <severidad>

Nombre: Tal como se verá en la consola de traps.

OID: OID principal del trap.

Severidad: Valor numérico, que tiene los siguientes valores: Severity 0 (Maintenance), 1(Info) , 2 (Normal), 3 (Warning), 4 (Critical), 5 (Minor) and 6 (Major).

Ejemplo:

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


1.10 Gráficas

1.10.1 create_custom_graph

Parámetros: <nombre_gráfica> <descripción> <usuario> <id_grupo> <ancho> <largo> <eventos> <tipo_gráfica> <periodo> <módulos> <separador>

Descripción: Se creará una gráfica con los elementos especificados. Todos los parámetros son obligatorios, pero se pueden dejar vacíos mediantes comillas simples. Si esto ocurre, los valores por defecto que toman los parámetros son los siguientes:

ancho: 550, alto: 210, periodo: 86400 (en segundos), eventos: 0, tipo_gráfica: 0, id_grupo: 0


Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_custom_graph 'Mi gráfica' 'gráfica creada por CLI' 'admin' 0 '' '' 0 2 '' '1;2;5;30' ';'

1.10.2 edit_custom_graph

Parámetros: <id_gráfica> <nombre_gráfica> <descripción> <usuario> <id_grupo> <ancho> <largo> <eventos> <tipo_gráfica> <periodo>

Descripción: Se editará una gráfica con los elementos especificados. Todos los parámetros son obligatorios, pero se pueden dejar vacíos mediante comillas simples. Si esto ocurre, los valores serán los que ya tenía la gráfica antes de la edición.


Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --edit_custom_graph 12 '' 'editando gráfica creada por CLI' '' '' '' '' '' '' 25200

1.10.3 add_modules_to_graph

Parámetros: <id_gráfica> <módulos> <separador>

Descripción: Se añadirán los módulos especificados en la gráfica seleccionada. Todos los parámetros son obligatorios.


Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_modules_to_graph 12 '25,26' ','

1.10.4 delete_modules_to_graph

Parámetros: <id_gráfica> <módulos> <separador>

Descripción: Se eliminarán los módulos especificados de la gráfica seleccionada. Todos los parámetros son obligatorios.


Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_modules_to_graph 12 '1,25,26' ','


1.11 Otras

1.11.1 meta_get_agent_group

Parámetros: <host> <api_pass> <user> <pass> <nombre_agente>

Descripción: Devuelve el nombre de grupo de un agente.


Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_get_agent_group http://127.0.0.1/pandora_console 1234 admin pandora NAS

1.11.2 meta_get_agent_group_id

Parámetros: <host> <api_pass> <user> <pass> <nombre_agente>

Descripción: Devuelve el id del grupo de un agente.


Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_get_agent_group_id http://127.0.0.1/pandora_console 1234 admin pandora NAS

1.11.3 meta_get_agent_group_id

Parámetros: <host> <api_pass> <user> <pass> <nombre_agente>

Descripción: Devuelve el id del grupo de un agente.


Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_get_agent_group_id http://127.0.0.1/pandora_console 1234 admin pandora NAS

1.11.4 meta_delete_agent

Parámetros: <host> <api_pass> <user> <pass> <nombre_agente>

Descripción: Borra un agente en la meta y en los nodos.


Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_delete_agent http://127.0.0.1/pandora_console 1234 admin pandora NAS


1.11.5 locate_agent

Parámetros: <nombre_agente>

Descripción: Busca un agente en los nodos de una metaconsola y devuelve el id de esta.


Ejemplo:

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

1.11.6 meta_set_create_group

Parámetros: <url_host> <api_pass> <user> <pass> <group_name> (<icon_name> | "<icon_name>|<id_group_parent>")

Descripción: Crea un grupo en la metaconsola


Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_set_create_group http://127.0.0.1/pandora_console 1234 admin pandora salamanca "world|14"
perl pandora_manage.pl /etc/pandora/pandora_server.conf --meta_set_create_group http://127.0.0.1/pandora_console 1234 admin pandora salamanca world

1.12 Ayuda

Para obtener la ayuda general del CLI de Pandora FMS bastaría con poner:

perl pandora_manage.pl --h

Para obtener la ayuda de una opción en particular bastaría con poner esa opción sin parámetros (esto para las opciones que usan parámetros)

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

Volver a Indice de Documentacion Pandora FMS