Interfaz de Línea de Comandos (CLI)

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:

/usr/share/pandora_server/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.

Versión Community:

El CLI es un fichero en Perl:

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

Con la barra inversa \ como conector de líneas:

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

Versión Enterprise:

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

Con la barra inversa \ como conector de líneas:

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

• Todos los parámetros, obligatorios u opcionales, pueden ser delimitados con comillas simples.
• El entrecomillado es especialmente útil cuando un parámetro tiene espacios, por ejemplo 'Mi Agente'.
• También si necesita omitir algún parámetro obligatorio puede utilizar dos comillas simples juntas . Dado el caso sea estrictamente necesario se mostrará un mensaje [ERROR] Error: seguido de la descripción del error. En el caso de los parámetros opcionales, si son varios y necesita especificar solamente el segundo y/o tercero y/o etcétera, utilice dos comillas simples juntas para indicar los parámetros opcionales vacíos.
• Algunos parámetros diferencian entre mayúsculas y minúsculas, otros son indiferentes. Por ejemplo, al crear un agente el nombre del servidor PFMS debe ser estrictamente igual, sin embargo el nombre del grupo primario al cual pertenecerá el agente puede estar en mayúsculas y/o minúsculas y si hay coincidencia el grupo será asignado.
• Se puede usar el alias de un agente, en vez de su nombre en sí, por medio de el parámetro use_alias al final de la línea de comando.

Para obtener la ayuda general del CLI de Pandora FMS use:

pandora_manage --h

Para obtener ayuda sobre una opción específica solo escriba la opción sin parámetros; por ejemplo para crear un usuario:

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

Parámetros obligatorios:

• < nombre_agente >
• < sistema_operativo >
  • Puede omitirse por medio de dos comillas simples juntas.
• < nombre_grupo >
• < nombre_servidor >
  • Distingue mayúsculas y minúsculas de manera exacta, de lo contrario se dejará nulo el valor del campo sin mostrar advertencia alguna. Asegúrese de que el agente haya sido asignado a un servidor.

Parámetros opcionales:

• < dirección IP o URL >
• < descripción >
  • Si omite la descripción será agregado Created by < nombre_servidor >.
• < intervalo >
• < alias como nombre >

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 descripción y un intervalo en segundos (por defecto 300).

El parámetro < alias como nombre > por defecto es 1 y con ese valor el alias del agente será igual que el nombre del agente. Si se desea que el nombre sea generado de forma aleatoria hay que poner este parámetro a 0. Si alguno de los tres primeros parámetros opcionales debe ser omitido utilice comillas simples juntas por cada omisión.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetros obligatorios:

• < nombre_del_agente >
• < campo_a_modificar >
• < nuevo_valor >

Parámetros opcionales:

• use_alias

Descripción: Se actualizará un <campo_a_modificar> de un agente existente. Los campos disponibles son los siguientes:

• agent_name
• address
• description
• group_name
• interval
• os_name
• disabled ( 0 para activarlo, 1 para inactivarlo).
• parent_name
• cascade_protection ( 0 para inactivarlo, 1 para activarlo).
• icon_path
• update_gis_data ( 0 para inactivarlo, 1 para activarlo).
• custom_id

Ejemplos (véase la llamada y su sintaxis):

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

Parámetros: <id_agente> <tipo_de_campo> <campo_a_cambiar> <valor_nuevo>

1. id_agente → identificador del agente.
2. tipo_de_campo → el cual puede ser 0 si es tipo texto o 1 si es de tipo lista desplegable compuesta de varias opciones (combo o combo box). Véase el apartado de respuestas. Ejemplo si existe:
3. campo_a_cambiar → nombre del campo a actualizar.
4. valor_nuevo → el valor del campo a actualizar.

Descripción: actualiza los campos personalizados (custom fields) de un agente.

Las respuestas de las que se componen son:

• ERROR:
  1. Si el agente no existe.
  2. Si el campo no existe.
  3. En el caso de que el valor_nuevo de un combo box no coincida con los que tiene preestablecido.
  4. Si no pudo actualizar el campo.

• INFO:
  1. Actualizando el campo X con el id de agente Y.
  2. Actualizado correctamente.

Ejemplos (véase la llamada y su sintaxis):

TIPO TEXTO:

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

TIPO COMBO:

pandora_manage /etc/pandora/pandora_server.conf --agent_update_custom_fields 1 1 'Nombres' 'Juan'

Parámetro obligatorio:

• < nombre_agente >

Parámetro opcional:

• use_alias
  • Tenga en cuenta que los alias de agente puede repetirse y puede borrar varios agentes en un solo paso.

Descripción:

Se eliminará el o los agente(s) pasando como parámetro su nombre o alias.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetro obligatorio:

• < nombre_de_grupo >

Descripción:

Desactiva todos los agentes de un grupo. Los agentes del grupo pasado como parámetro serán desactivados con la ejecución de esta opción.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetro obligatorio:

• < 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 (véase la llamada y su sintaxis):

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

Parámetro obligatorio:

• < nombre_del_grupo_nuevo >

Parámetros opcionales:

• < nombre_del_grupo_superior >
• < icono >
  • 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
• < descripción >

Descripción:

Un nuevo grupo será creado si el nombre no existe y, opcionalmente, se le puede asignar un grupo “padre” o superior, un icono para identificación gráfica (el nombre del icono, sin extensión, utilice solamente las opciones listadas) y una descripción. El grupo padre por defecto es 'All' y el icono por defecto es una cadena de texto vacía (sin icono, no lo usará).

Ejemplo (véase la llamada y su sintaxis):

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

Parámetro obligatorio:

• < nombre_de_grupo >

Descripción:

Borra un grupo de agentes y sus agentes.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetro obligatorio:

• < id_grupo >

Parámetros opcionales:

• < nombre_del_grupo_a_modificar >
• < nombre_del_grupo_superior >
• < icono >
  • 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
• < descripción >

Descripción:

Un grupo es modificado por medio de su identificador numérico. Los parámetros que pueden ser modificados son:

• Nombre del grupo.
• Nombre del grupo “padre” o superior.
• Icono (solo el nombre, sin extensión de fichero, escoja uno de la lista descrita).
• Descripción.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetro obligatorio:

• < nombre_de_parada_planificada >

Descripción:

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

• [ERROR] Planned_downtime < nombre_de_parada_planificada > cannot be stopped (la parada planificada no puede ser detenida).
• [INFO] Planned_downtime < nombre_de_parada_planificada > is already stopped (la parada planificada ya está detenida).
• [INFO] Stopping planned downtime < nombre_de_parada_planificada > (deteniendo parada planificada).

Ejemplo (véase la llamada y su sintaxis):

pandora_manage /etc/pandora/pandora_server.conf --stop_downtime 'Downtine name'

Parámetro obligatorio:

• < nombre_de_agente >

Parámetro opcional:

• use_agent_alias

  Para identificar al agente por medio de su alias en vez de su nombre, utilice use_alias justo al final.

Descripción: Obtener el estado de un agente determinado por medio de su nombre o alias.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetro obligatorio:

• < nombre_de_agente >

Parámetro opcional:

• use_agent_alias

  Para identificar al agente por medio de su alias en vez de su nombre, utilice use_alias justo al final.

Descripción: Obtener el grupo de un agente determinado por medio de su nombre o alias.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetro obligatorio:

• < nombre_de_agente >

Parámetro opcional:

• use_agent_alias

  Para identificar al agente por medio de su alias en vez de su nombre, utilice use_alias justo al final.

Descripción: Obtener el identificador de un agente determinado por medio de su nombre o alias.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetro obligatorio:

• < nombre_de_agente >

Parámetro opcional:

• use_agent_alias

  Para identificar al agente por medio de su alias en vez de su nombre, utilice use_alias justo al final.

Descripción: Obtener los módulos (identificadores y nombres, separados por una coma) de un agente determinado por medio de su nombre o alias.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetro obligatorio: Ninguno. Para obtener ayuda de dicho comando puede utilizar (véase la llamada y su sintaxis):

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

Obtendrá la siguiente respuesta indicando que excede la cantidad de parámetros:

[ERROR] Parameters error: 8 received | 0-7 necessary.
 
Pandora FMS CLI 7.0NG.764 Build 220930 Copyright (c) 2013-2023 Pandora FMS SL
This program is Free Software, licensed under the terms of GPL License v2
You can download latest versions and documentation at https://pandorafms.com/
 
[*] 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.

Parámetros opcionales: permiten filtrar la lista de agentes en un formato serializado donde importa el orden, utilice dos comillas simples para obviar parámetro(s). Se numeran aquí para mejor control y visualización:

1. < nombre_de_grupo >
2. < nombre_de_sistema_operativo >
3. < estado > Valores posibles: critical, warning, unknown, normal.
4. < cantidad_máxima_de_módulos >
5. < palabra_clave > Permite filtrar por nombre de agente (o alias de agente si agrega al final use_agent_alias ).
6. < nombre_de_política >
7. use_agent_alias

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

Ejemplo (véase la llamada y su sintaxis):

• Obtener todos los agentes en el grupo Network:

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

• Obtener todos los agentes que tengan Linux como sistema operativo:

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

• Obtener todos los agentes cuyo estado sea normal:

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

• Obtener todos los agentes con cero módulos (sin módulo alguno):

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

• Obtener todos los agentes con cero módulos en el grupo Servers:

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

• Obtener todos los agentes que contengan la palabra test en su alias:

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

Parámetros: <alias_de_agente> [ strict ]

Descripción: Lista los identificadores y alias de los agentes que coinciden con el alias especificado. Usando el parámetro opcional strict limita la búsqueda a una coincidencia exacta.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agents_id_name_by_alias 'Estación'

(>=5.0)

Parámetros: <agent_name> <use_agent_alias>

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'

(>=5.0)

Parámetros: <use_agent_alias>

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'

Parámetros: Ninguno.

Descripción:

1. Se listarán los ficheros de configuración mal configurados buscando en los tokens principales:
   • server_ip
   • server_path
   • temporal
   • logfile
2. En caso de haber ficheros corruptos y que no puedan ser abiertos: [WARN] Can't open file < path_file >.
3. En caso de no encontrar el fichero en la ruta: [WARN] File not exist < path_file >.
4. En caso de que los archivos de configuración estén correctos (según los tokens del primer punto): [INFO] No bad files found

Ejemplos:

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

Resultado del ejemplo:

(>=7.21) solo para la metaconsola

Parámetros: [id del agente a migrar] [nombre del nodo origen] [nombre del nodo destino] [parámetro opcional por defecto está a 0 migrará los datos tanto de histórico como de la propia db si está a 1 solo migrará los de la propia bd]

Descripción: Se añade un agente a la cola de migración para mover de nodo a otro nodo esto es solo para la metaconsola. Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en pandora_server.conf.

Ejemplo:

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

(>=7.21) solo para la metaconsola

Parametrizes: [id del agente a comprobar]

Descripción: Devolverá true o false dependiendo si el agente introducido existe en la tabla de migración de agentes. Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en pandora_server.conf.

Ejemplo:

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

Parámetros: <nombre_de_parada_planificada> <descripción> <fecha_desde> <fecha_hasta> <id_grupo> <lunes (0|1)> <martes (0|1)><miércoles (0|1)> <jueves (0|1)> <viernes (0|1)> <sábado (0|1)> <domingo (0|1)> <hora_desde_en_período HH:MM:SS><hora_hasta_en_período HH:MM:SS> <día_número_desde_en_período> <día_número_hasta_en_período><tipo_de_parada_planificada> <tipo_de_ejecución> <tipo_de_periodicidad> <id_usuario>

Descripción: Se creará una parada planificada con los datos enviados.

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

Parámetros obligatorios:

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

Descripción:

Se añadirán registros a una parada planificada con los datos enviados. Escriba la lista de identificadores de agentes y la lista de nombres de módulo sin dejar espacios entre las comas que separan los componentes de ambas listas. Si el nombre de un módulo contiene espacios, coloque dicho nombre de módulo entre dos comillas simples. Si se pasan dos o más agentes, se asume de manera predeterminada que se quiere agregar módulos comunes, de no ser así mostrará un mensaje de advertencia.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetros obligatorios:

• < nombre_a_buscar >

Parámetros opcionales:

• < id_grupo >
• < tipo_de_parada_planificada >
  • quiet
  • disable_agents
  • disable_agents_alerts
• < tipo_de_ejecución >
  • once
  • periodically
• < tipo_de_periodicidad >
  • weekly
  • monthly

Descripción:

Se listarán todos los registros que coincidan con los datos enviados. Consulte las opciones de paradas de servicio planificadas.

Ejemplo (véase la llamada y su sintaxis):

Para obtener toda la lista de paradas planificadas:

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

Parámetros obligatorios:

• < nombre_a_buscar >

Parámetros opcionales:

• < id_grupo >
• < tipo_de_parada_planificada >
  • quiet
  • disable_agents
  • disable_agents_alerts
• < tipo_de_ejecución >
  • once
  • periodically
• < tipo_de_periodicidad >
  • weekly
  • monthly

Descripción:

Se listarán todos los items que coincidan con el nombre de la parada de servicio solicitada. Consulte las opciones de paradas de servicio planificadas.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetro obligatorio:

• < id_parada_planificada >

Descripción:

Borra una parada planificada por medio de su identificador corresondiente. Algunos mensajes de retorno:

This planned downtime is deleted “Esa parada planificada está borrada.”

Problems with this planned downtime “Problemas con esta parada planificada.”

The scheduled downtime is still being executed “Esta parada planificada aún está en ejecución.”

Ejemplo (véase la llamada y su sintaxis):

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

Parámetros obligatorios:

• < id_de_agente >
• Para Metaconsola el < id_metaconsola >, para los nodos coloque cualquier valor ya que es indiferente.

Parámetros opcionales:

• < valor > Por defecto 1 para habilitar el agente, 0 para deshabilitar.

Descripción: Deshabilita un agente y además, si tiene configuración remota, lo pone en modo standby.

Ejemplo (véase la llamada y su sintaxis):

• Ejemplo para habilitar un agente desde el nodo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 0 1

• Ejemplo para deshabilitar un agente desde nodo:

pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 0 0

• Ejemplo para habilitar un agente desde la metaconsola:

pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 1 1

• Ejemplo para deshabilitar un agente desde la metaconsola:

pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 1 0

Parámetros: <id_agent>

Descripción: Sincroniza los conteos de módulos y alertas de un agente dado. En caso de que se quiera sincronizar con todos los agentes el primer parámetro debe ser “All”.

Ejemplo:

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

Parámetros obligatorios:

• < id_del_agente >
• < latitud >
• < longitud >
• < altitud >

Parámetros opcionales:

• Ninguno.

Descripción: Actualiza los datos GIS de un agente.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetros obligatorios:

• < id_del_agente >

Parámetros opcionales:

• Ninguno.

Descripción: Obtiene los datos GIS de un agente.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetros obligatorios:

• < id_del_agente >
• < id_del_sistema_operativo >
• < versión_del_sistema_operativo >

Parámetros opcionales:

• Ninguno.

Descripción: Permite agregar o cambiar el sistema operativo (y obsolescencia) a un agente.

Ejemplo (véase la llamada y su sintaxis):

pandora_manage /etc/pandora/pandora_server.conf --cli_agent_set_os 7 3 'Ubuntu 16.04'

Parámetros obligatorios:

• < nombre_de_módulo >
• < tipo_de_módulo >
• < nombre_de_agente >

Parámetros opcionales:

1. < descripción >
2. < grupo_módulo>
3. < mínimo >
4. < máximo >
5. < post_proceso >
6. < intervalo >
7. < mínimo_de_advertencia >
8. < máximo_de_advertencia >
9. < mínimo_crítico >
10. < máximo_crítico >
11. < datos_histórico >
12. < fichero_de_definición >
13. < cadena_de_advertencia >
14. < cadena_de_criticidad >
15. < habilitar_eventos_desconocidos >
16. < umbral_flip-flop >
17. < cada_flip-flop >
18. < umbral_flip-flop_normal >
19. < umbral_flip-flop_advertencia >
20. < umbral_flip-flop_crítico >
21. < tiempo_de_espera_flip-flop >
22. < inverso_de_advertencia >
23. < inverso_de_criticidad >
24. < instrucciones_de_criticidad >
25. < instrucciones_de_advertencia >
26. < instrucciones_de_estado_desconocido >
27. use_agent_alias: Para la búsqueda del agente utiliza el alias del agente en vez del nombre del agente.
28. ignore_unknown: Descarta el cálculo de estado desconocido, de manera que el módulo nunca cambiará a dicho estado y conservará siempre el último estado conocido.

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 (ver opción use_agent_alias) donde se creará. Opcionalmente se le podrá otorgar una descripción, el grupo del módulo, etcétera.

Los valores por defecto son 0 para los mínimos y máximos, datos_histórico y post_proceso; 300 para el intervalo.

Ejemplo (véase la llamada y su sintaxis):

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

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

pandora_manage /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/definition_file 'warning text' 'critical text'

Parámetros obligatorios:

• < nombre_de_módulo >
• < tipo_de_módulo >
• < nombre_de_agente >

Parámetros opcionales:

1. < descripción >
2. < grupo_módulo>
3. < mínimo >
4. < máximo >
5. < post_proceso >
6. < intervalo >
7. < mínimo_de_advertencia >
8. < máximo_de_advertencia >
9. < mínimo_crítico >
10. < máximo_crítico >
11. < datos_histórico >
12. < reintentos >
13. < consultas >
14. < identificados_navegador_agente >
15. < servidor_autenticación >
16. < ámbito_de_autoridad >
17. < fichero_de_definición >
18. < url_de_proxy >
19. < autorización_proxy_auth_login >
20. < contraseña_autorización_proxy_auth_login >
21. < cadena_de_advertencia >
22. < cadena_de_criticidad >
23. < habilitar_eventos_desconocidos >
24. < umbral_flip-flop >
25. < cada_flip-flop >
26. < umbral_flip-flop_normal >
27. < umbral_flip-flop_advertencia >
28. < umbral_flip-flop_crítico >
29. < tiempo_de_espera_flip-flop >
30. < inverso_de_advertencia >
31. < inverso_de_criticidad >
32. < instrucciones_de_criticidad >
33. < instrucciones_de_advertencia >
34. < instrucciones_de_estado_desconocido >
35. use_agent_alias: Para la búsqueda del agente utiliza el alias del agente en vez del nombre del agente.
36. ignore_unknown: Descarta el cálculo de estado desconocido, de manera que el módulo nunca cambiará a dicho estado y conservará siempre el último estado conocido.

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 (ver parámetro use_agent_alias) donde se creará. Opcionalmente se le podrá otorgar una descripción, el grupo del módulo, unos valores mínimo y máximo, un fichero de definición del módulo, entre otros parámetros.

Ejemplo (véase la llamada y su sintaxis):

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

task_begin
get http://pandorafms.com
task_end

Ejemplo:

pandora_manage /etc/pandora/pandora_server.conf --create_web_module 'module_name' web_data 'pandorafms' 'Module description' 'General' 0 100 0 300 0 0 0 0 1 0 1 'Pandora FMS' auto public /home/user/file_definition 'http://proxy.url' 'proxy_login' 'proxy_password' 1 10 10 10 10 10 10 10 10 1 1 'critical_instructions' 'warning_instructions' 'unknown_instructions'

Parámetros obligatorios:

• < nombre_modulo >
• < tipo_modulo >
• < nombre_agente >
• < dirección_modulo >

Parámetros opcionales:

• < puerto_modulo > valor numérico entre 1 y 65535.
• < descripción >
• < 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 >
• use_agent_alias para buscar el agente por su alias en vez de su nombre.
• ignore_unknown Descarta el cálculo de estado desconocido, de manera que el módulo nunca cambiará a dicho estado y conservará siempre el último estado conocido.

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 número de puerto, una descripción, unos valores mínimos y máximos, un valor ' de post procesado, un intervalo en segundos, unos valores de advertencia mínimos y máximos, unos valores de criticidad mínimos y máximos, y un valor de datos históricos.

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

El número de puerto es opcional, ya que los módulos de tipo ICMP no precisan de él. En el resto de los tipos es necesario especificar un módulo.

Ejemplo (véase la llamada y su sintaxis):

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

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

Descripción: Se creará un componente de red. 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 mínimos y máximos, history_data y post_process y 300 para el intervalo.

El puerto es optativo ya que los 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 /tmp/pandorafms/pandora_server/util/pandora_manage.pl /etc/pandora/pandora_server.conf --create_network_component "example_name" 2 7

Parámetros obligatorios:

• < module_name >
• < module_type >
• < agent_name >
• < module_address >
• < module_port >
• < version >

Parámetros opcionales:

• < 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 para buscar el agente por su alias en vez de su nombre.
• ignore_unknown Descarta el cálculo de estado desconocido, de manera que el módulo nunca cambiará a dicho estado y conservará siempre el último estado conocido.

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 un nombre de comunidad, un OID, una descripción, el grupo del módulo, unos valores mínimos y máximos, un valor de post procesado, un intervalo en segundos, unos valores de advertencia mínimos y máximos, unos valores de criticidad mínimos y máximos, y los parámetros de SNMP 3 tales como métodos, contraseñas, etcétera.

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

Ejemplo (véase la llamada y su sintaxis):

pandora_manage /etc/pandora/pandora_server.conf --create_snmp_module 'My module' remote_snmp_inc 'My agent' 192.168.12.123 8080 1 my_comunnity my_oid 'Module description'

Parámetros obligatorios:

• < nombre_modulo >
• < tipo_modulo >
• < nombre_agente >
• < direccion_modulo >
• < puerto_modulo > valor numérico entre 1 y 65535.
• < nombre_plugin >
• < usuario >
• < password >
• < parametros >

Parámetros opcionales:

• < descripción >
• < 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 >
• use_agent_alias para buscar el agente por su alias en vez de su nombre.
• ignore_unknown Descarta el cálculo de estado desconocido, de manera que el módulo nunca cambiará a dicho estado y conservará siempre el último estado conocido.

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 mínimos y máximos, un valor de post procesado, un intervalo en segundos, unos valores de advertencia mínimos y máximos, unos valores de criticidad mínimos y máximos, entre otros valores opcionales.

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

Ejemplo (véase la llamada y su sintaxis):

pandora_manage /etc/pandora/pandora_server.conf --create_plugin_module 'My module' 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

Parámetros: [<nombre del grupo de módulo>]

Descripción: Muestra los grupos de módulos disponibles. Podemos filtrar añadiendo el nombre del grupo o parte de este.

Ejemplo:

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

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'

Parámetros: <nombre_servidor_1|nombre_servidor_2|…nombre_servidor_n> [<return_type>]

Descripción: Se sincronizarán los grupos de módulos de la meta con los nodos que hayan sido especificados en el primer parámetro, separados con “|”. De manera opcional se podrá indicar en el segundo parámetro el formato en que se devolverán los datos (csv o json). Por defecto vendrán en formato csv.

Ejemplo:

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

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

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

Parámetros obligatorios:

• < nombre_de_módulo >
• < nombre_de_agente >

Parámetros opcionales:

• use_alias

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. A partir de la versión 771 se eliminan recursivamente los descendientes del módulo borrado.

Ejemplos (véase la llamada y su sintaxis):

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

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

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' 'My module' 'generic_data' 1 '2010-05-31 15:53'

(>=5.0)

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

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

Parametros: <agent_id> <module_name>

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

Ejemplo:

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

Parametros: <agentmodule_id>

Descripción: Se devolverá el valor del campo Custom ID de un módulo concreto de un agente.

Ejemplo:

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

Parametros: <agentmodule_id> [<custom_id>]

Descripción: Se insertará el valor del campo Custom ID de un módulo concreto de un agente. Si se deja en blanco eliminará el contenido que hubiese anteriormente dejando el campo vacío.

Ejemplo:

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

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

Descripción: Se eliminarán 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'.

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

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'

Parametros: <nombre_agente> <nombre_módulo> <nombre_etiqueta>

Descripción: Adiciona una etiqueta (tag) al módulo especificado.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_tag_to_module 'Nombre de agente' 'Nombre de módulo' 'Nombre de etiqueta'

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

(>=5.0)

Parámetros: <agent_name> <component_name> <use_agent_alias>

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'

(>=5.1)

Parámetros: <agent_name> <component_name> <use_agent_alias>

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'

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

Parámetros: [<id_template> <id_agent>]

Descripción: Estas plantillas de módulos son una agrupación que contiene módulos de comprobación de red. Estas plantillas pueden ser aplicadas directamente a agentes, evitando tener que añadir módulos uno a uno.

Ejemplo:

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

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

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 'My module' 'Mi agente'

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

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 'My module' 'Mi agente'

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

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 'My module' 'Mi agente' 0 4

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

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 'My module' 'Mi agente'

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

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

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)
• Estado distinto a normal:
  • Sintaxis: <type>
  • Ejemplo: not_normal (Alerta cuando el estado sea distinto a normal -warning, critical, etc.-)
• 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' "max_min@1@3@5" 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   @

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

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

(>=5.0)

Parámetros: [<action_name> <separator> <return_type>]

Descripción: Devuelve todas las acciones de las alertas. Opcionalmente se puede filtrar el resultado por el nombre. De manera opcional en el segundo parámetro se puede especificar el separador de los resultados y en el tercer parámetro el formato de la lista devuelta (csv, json, string).

Ejemplo:

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

(>=5.0)

Parámetros: [<server_name> <action_name> <separator> <return_type>]

Descripción: Devuelve todas las acciones de alerta de la metaconsola. Opcionalmente se puede filtrar el resultado por el nombre del nodo o por nombre de la acción. De manera opcional en el segundo parámetro se puede especificar el separador de los resultados y en el tercer parámetro el formato de la lista devuelta (csv, json, string).

Ejemplo:

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

(>=5.0)

Parámetros: <name> <command> [<group name> <description> <internal> <field_description> <field_value>]

Descripción: Se creará un comando con los datos de nombre y comando especificados. Opcionalmente se podrá especificar:

• Nombre del grupo. Si no se proporciona grupo se asignará en el grupo 'All'.
• Descripción del comando.
• Internal (1-0).
• Descripción de campos. Este se pasará en el siguiente formato: '[“descr1”,“descr2”,“descr3”,“descr4”,“descr5”]'.
• Valor de los campos: Este se pasará en el siguiente formato: [“val1”,“val2”,“val3”,“val4”,“val5”].

Ejemplo:

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

(>=5.0)

Parámetros: [<name> <command> <group name> <description> <internal>]

Descripción: Permite ver todas las alertas. Opcionalmente se puede filtrar el resultado por: nombre, comando, grupo, descripción o si es interno (1-0). En el caso del nombre, comando y descripción no hace falta introducir el dato exacto.

Ejemplo:

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

Parámetros: <nombre_de_plantilla> <id_de_agente> <id_de_módulo> [ use_alias ]

Descripción: Valida una alerta dados un nombre de plantilla, un ID de agente y un ID de módulo. En lugar de utilizar sólo un ID de agente, puede utilizar el nombre del agente con el último parámetro use_alias (quizás para validar múltiples alertas).

Ejemplo:

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

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

(>=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, miércoles, jueves, viernes, sábado y domingo.

Example:

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

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

(>=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, miércoles, jueves, viernes, sábado y domingo.

Example:

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

Parámetros: <valor>

Descripción: Habilita (1) o deshabilita (0) la protección contra tormenta de eventos.

Example:

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

Parámetros obligatorios:

• < id_usuario >
• < contraseña >
• < es_admin >

Parámetros opcionales:

• < comentarios >

Descripción:

Se creará un usuario con el identificador de usuario (el cual será también su nombre de usuario) y la contraseña recibida. Además se recibirá un valor binario (<es_admin> 0 falso or 1 verdadero) que especifique si el usuario será o no superadmin. De forma optativa se podrán agregar un comentario acerca del usuario creado.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetro obligatorio:

• < id_usuario >

Descripción:

Se eliminará un usuario pasado su nombre como parámetro.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetros obligatorios:

• < id_usuario >
• < campo_a_actualizar >
• < valor_nuevo >

Descripción:

A un usuario existe le actualiza el campo dado. Los campos posibles son los siguientes:

• email : correo electrónico.
• phone : número de teléfono.
• is_admin : ¿Es superadmin? (0 falso,1 verdadero).
• language idioma, valores posibles:
  • default, inglés Estados Unidos.
  • ca, catalán.
  • en_GB, inglés Reino Unido.
  • es, español.
  • fr, francés.
  • ru, ruso.
  • ja, japonés.
  • zh_CN , chino.
• id_skin (únicamente funciona para la versión Enterprise) Cambia el tema gráfico del usuario.
• comments : Comentarios.
• fullname : Nombre completo del usuario.
• password : Contraseña del usuario, utilice comillas si contiene espacios.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetro obligatorio:

• < id_usuario >

Descripción:

Un usuario existente será activado. Si ya está activo, solamente se mostrará un mensaje.

Ejemplo (véase la llamada y su sintaxis):

pandora_manage.pl /etc/pandora/pandora_server.conf –enable_user 'user 9500'

Parámetro obligatorio:

• < id_usuario >

Descripción:

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

Ejemplo (véase la llamada y su sintaxis):

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

Parámetros obligatorios:

• < nombre_perfil >
• < lista_de_permisos > Utilice 1 ó 0 otorgar o negar permiso, respectivamente. Son numerados de esta manera:
  1. Ver agentes (AR View agents).
  2. Editar agentes (AW Edit agents).
  3. Desactivar agentes (AD Disable agents).
  4. Editar alertas (LW Edit alerts).
  5. Gestionar alertas (LM Manage alerts).
  6. Gestionar usuarios (UM Manage users).
  7. Gestionar base de datos (DM Manage database).
  8. Ver eventos (ER View events).
  9. Editar eventos (EW Edit events).
  10. Gestionar eventos (EM Manage events).
  11. Ver informes (RR View reports).
  12. Editar informes (RW Edit reports).
  13. Gestionar informes (RM Manage reports).
  14. Ver mapas (MR View network maps).
  15. Editar mapas (MW Edit network maps).
  16. Gestionar mapas (MM Manage network maps).
  17. Ver consola visual (VR View visual console).
  18. Editar consola visual (VW Edit visual console).
  19. Gestionar consola virtual (VM Manage visual console).
  20. Gestionar Pandora PFMS (PM Pandora FMS management).
  21. Ver Network Config Management (NR View NCM data).
  22. Operar Network Config Management (NW Operate NCM -debe incluir NR-).
  23. Gestionar Network Config Management (NM Manage NCM -debe incluir NW y NR).

Descripción:

Se creará un nuevo perfil pasándole como parámetros el nombre del perfil y los permisos. Todos los campos son obligatorios.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetros obligatorios:

• < nombre_perfil >
• < lista_de_permisos > Utilice 1 ó 0 otorgar o negar permiso, respectivamente. Son numerados de esta manera:
  1. Ver agentes (AR View agents).
  2. Editar agentes (AW Edit agents).
  3. Desactivar agentes (AD Disable agents).
  4. Editar alertas (LW Edit alerts).
  5. Gestionar alertas (LM Manage alerts).
  6. Gestionar usuarios (UM Manage users).
  7. Gestionar base de datos (DM Manage database).
  8. Ver eventos (ER View events).
  9. Editar eventos (EW Edit events).
  10. Gestionar eventos (EM Manage events).
  11. Ver informes (RR View reports).
  12. Editar informes (RW Edit reports).
  13. Gestionar informes (RM Manage reports).
  14. Ver mapas (MR View network maps).
  15. Editar mapas (MW Edit network maps).
  16. Gestionar mapas (MM Manage network maps).
  17. Ver consola visual (VR View visual console).
  18. Editar consola visual (VW Edit visual console).
  19. Gestionar consola virtual (VM Manage visual console).
  20. Gestionar Pandora PFMS (PM Pandora FMS management).
  21. Ver Network Config Management (NR View NCM data).
  22. Operar Network Config Management (NW Operate NCM -debe incluir NR-).
  23. Gestionar Network Config Management (NM Manage NCM -debe incluir NW y NR).

Descripción:

Se modificará un perfil existente pasándole como parámetros el nombre del perfil y los permisos. Todos los campos son obligatorios.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetros obligatorios:

• < id_usuario >
• < nombre_perfil >
• < nombre_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 (véase la llamada y su sintaxis):

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

Parametros: <id_usuario> <nombre_de_etiqueta> <nombre_de_grupo> <nombre_de_perfil>

Descripción: Añadir una etiqueta (tag) al perfil (profile) de un usuario dado.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_tag_to_user_profile '7' 'nueva etiqueta' 'All' 'Perfil del usuario 7'

Parámetros obligtorios:

• < id_usuario >
• < nombre_perfil >
• < nombre_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 privilegios el perfil. Si el perfil a eliminar está asociado al grupo All debe especificar como grupo All.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetros obligatorios:

• < id_usuario >
• < nombre_perfil >

Parámetro opcional:

• < nombre_grupo >

Descripción:

Añade un perfil en grupo existente a un usuario. Si no se proporciona grupo se asignará en el grupo All.

Ejemplo (véase la llamada y su sintaxis):

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

Parámetros: Ninguno.

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

Parámetros: Ninguno.

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

Parámetro obligatorio: <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'

Parámetros obligatorios:

• Nombre del evento.
• Tipo de evento. 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_critical , going_down_normal , going_down_warning, going_down_critical , going_up_normal , configuration_change .
• Nombre de grupo.

Parámetros opcionales:

• Nombre del agente.
• Nombre del módulo.
• Estado del evento (0 si no está validado, 1 si está validado y 2 en proceso).
• Severidad: 0 (Mantenimiento), 1 (Informativo), 2 (Normal), 3 (Advertencia), 4 (Crítica), 5 (Menor) y 6 (Mayor).
• Nombre de la plantilla en el caso de que esté asociado a una alerta.
• Nombre de usuario.
• Comentario.
• Fuente.
• Identificador adicional.
• Etiquetas: El formato de las etiquetas debe ser <etiqueta> <url>. Se pueden añadir varias etiquetas separadas por comas: < etiqueta > < url >,< etiqueta > < url >. 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} .
• Forzar creación de agente (bool): Si el parámetro de nombre del agente hace referencia a un agente que no existe, entonces será creado.
• Instrucciones en crítico: Añade las instrucciones a realizar en caso de pasar a estado crítico.
• Instrucciones en advertencia: Añade las instrucciones a realizar en caso de pasar a estado de advertencia.
• Instrucciones en desconocido: Añade las instrucciones a realizar en caso de pasar a estado desconocido.
• Usar alias del agente, utilice textualmente use_alias. Se deben especificar dos comillas simples juntas, sin espacio entre ellas) si utiliza el siguiente parámetro a continuación.
• Metaconsola: Identificador del servidor (solo versión Enterprise).

Descripción:

Se creará un evento con los datos nombre y tipo del evento, y nombre del módulo, agente y grupo asociados.

Ejemplo (véase la llamada y su sintaxis):

pandora_manage /etc/pandora/pandora_server.conf --create_event \
    'Event CLI' \
    system \
    Firewalls \
    'My agent' 'My module' 0 4 Template004 \

Parámetros: <nombre_agente> <nombre_modulo> <fechahora_min> <fechahora_max> <nombre_usuario> <criticidad> <nombre_plantilla> <use_agent_alias> 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 módulo, 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' 'My module'  '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.

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

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

Parámetros obligatorios:

• < id_evento >
• < id_user >
• < comentario >

Descripción:

Añade un comentario a un evento.

Ejemplo (véase la llamada y su sintaxis):

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

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

Parámetros: <id_evento>

Descripción: Pone un evento en progreso.

Example:

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

Parámetros obligatorios:

• < id_evento >
• < id_personalizado_de_evento >

Descripción:

Añade un identificador personalizado a un evento.

Ejemplo (véase la llamada y su sintaxis):

pandora_manage /etc/pandora/pandora_server.conf --update_event_custom_id '232' 'CLI test'

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'

Parámetros: <nombre_política>

Descripción: Se aplicará de forma forzada una política. 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.

Como este comando trabaja a través de la API, necesita los siguientes parámetros:

• id =<id_policy> (obligatorio)
• id2=<id_agent> (opcional) Id o nombre del agente según se indique en el parámetro other. Si viene vacío se aplicará la política a todos los agentes de esta.
• other =<parámetros serializados>
  • <name_agent (Boolean)> Indica si se enviará el agente por Id (0) o por nombre (1).
  • <id_servidor> (obligatorio en caso de usar Metaconsola) Id del servidor sobre el que se aplicará la política.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --apply_policy 'id_politica' 'id_agente' 'other1|other2'

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

(>=5.0)

Parámetros: <nombre_agente> <nombre_politica> <use_agent_alias>

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'

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'

Parámetros: <id_de_colección_de_ficheros>

Descripción: Vuelve a recrear los ficheros de una colección.

Devuelve [INFO] Collection recreated successfully. (“La colección ha sido recreada con éxito”),

de otra manera [ERROR] Collection not recreated. (“Colección no recreada”).

Ejemplo:

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

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'

Parámetros: Ninguno.

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_not_policy_modules

Parámetros: <id_policy> <id_agent>

Descripción:Elimina un agente de una política. Es necesario especificar el id de la política y el id del agente que se quiere eliminar.

Ejemplo:

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

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'

Parámetros obligatorios:

• < nombre_política >
• < nombre_modulo >
• < tipo_modulo >

Parámetros opcionales:

• < descripción >
• < 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 >
• ignore_unknown Descarta el cálculo de estado desconocido, de manera que el módulo nunca cambiará a dicho estado y conservará siempre el último estado conocido.

Descripción: 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.

Ejemplo:

Ejemplo (véase la llamada y su sintaxis):

pandora_manage /etc/pandora/pandora_server.conf --create_policy_data_module 'Policy name' 'Module name' generic_proc 'Module description' 'group module' 0 100 0 300 30 60 61 100 0 'module_begin\nmodule_name modname\nmodule_end' 'Warning string' 'Critical string'

Parámetros obligatorios:

• < nombre_política >
• < nombre_modulo >
• < tipo_modulo >

Parámetros opcionales:

• < descripción >
• < grupo_modulo >
• < min >
• < max >
• < post_process >
• < intervalo >
• < 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 >
• ignore_unknown Descarta el cálculo de estado desconocido, de manera que el módulo nunca cambiará a dicho estado y conservará siempre el último estado conocido.

Descripción: 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.

Ejemplo (véase la llamada y su sintaxis):

pandora_manage /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' 'warning_instructions' 'unknown_instructions'

Parámetros obligatorios:

• < policy_name >
• < module_name >
• < module_type >

Parámetros opcionales:

• < module_port > valor numérico entre 1 y 65535.
• < 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 >
• ignore_unknown Descarta el cálculo de estado desconocido, de manera que el módulo nunca cambiará a dicho estado y conservará siempre el último estado conocido.

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.

Ejemplo (véase la llamada y su sintaxis):

pandora_manage /etc/pandora/pandora_server.conf --create_policy_network_module 'Policy name' 'Module name' remote_icmp_proc 22 'Module description' 'Name group' 0 100 0 300 30 60 61 100 0 0 'Warning string' 'Critical string'

Parámetros obligatorios:

• < policy_name >
• < module_name >
• < module_type >
• < module_port >
• < version >

Parámetros opcionales:

• < 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 >
• ignore_unknown Descarta el cálculo de estado desconocido, de manera que el módulo nunca cambiará a dicho estado y conservará siempre el último estado conocido.

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.

Ejemplo (véase la llamada y su sintaxis):

pandora_manage /etc/pandora/pandora_server.conf --create_policy_snmp_module 'Policy name' 'Module name' remote_snmp_inc 8080 1 mycommunity myoid 'Module description'

Parámetros obligatorios:

• < policy_name >
• < module_name >
• < module_kind >
• < module_port > valor numérico entre 1 y 65535.
• < plugin_name >
• < user >
• < password >
• < parameters >

Parámetros opcionales:

• < 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>
• ignore_unknown Descarta el cálculo de estado desconocido, de manera que el módulo nunca cambiará a dicho estado y conservará siempre el último estado conocido.

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.

Ejemplo (véase la llamada y su sintaxis):

pandora_manage /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 'Warning string' 'Critical string'

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

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

(>=5.0)

Parámetros: [<agent_name> <use_agent_alias>]

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'

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

Ejemplo:

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

(>=5.0)

Parámetros: <option_to_execute> <option_params>

Descripción: 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

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

Parámetros: Ninguno.

Inicia el proceso snmptrapd en el servidor de traps. En caso de estar ya iniciado, finaliza dicho servicio (comando kill) y lo ejecuta de nuevo, borrando todos los traps ubicados en el log de intercambio ( por defecto /var/log/pandora/pandora_snmptrapd.log ).

Ejemplo:

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

Parámetros: <nombre_gráfica> <descripción> <usuario> <id_grupo> <ancho> <altura> <eventos> <tipo_de_gráfica> <período> <módulos> <separador>

Descripción: Se creará una gráfica con los elementos especificados. Dos o más módulos deben ser distinguidos con <separador>, el cual siempre debe ser especificado, incluso para un solo módulo. Todos los parámetros son obligatorios, pero algunos 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.
• Altura: 210.
• Período: 86400 (en segundos).
• Eventos: 0.
• Tipo de 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' ';'

Parámetros: <id_gráfica> <nombre_de_gráfica> <descripción> <usuario> <id_grupo> <ancho> <alto> <eventos> <tipo_de_gráfica> <período>

Descripción: Se editará una gráfica con los elementos especificados. Todos los parámetros son obligatorios, pero algunos 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 2 '' 'edit graph by CLI' '' '' '' '' '' '' 25200

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 2 '1015,1017' ','

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 2 '1015,1017' ','

Parámetros: <nombre_clúster> <tipo_clúster> <descripción> <id_grupo>

Descripción: Se creará un clúster con los parámetros especificados y sus elementos asociados.

Ejemplo:

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

Parámetros: <json_data_base64:[{“id”:5,“id_agent”:2},{“id”:5,“id_agent”:3}]>

Descripción: Se añadirá un agente concreto al clúster especificado. Es absolutamente necesario que los JSON se codifiquen en base 64.

Ejemplo :

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

Parámetros:

Datos en formato JSON con los siguientes campos:

• name : (valor de cadena de texto).
• id_cluster : (valor numérico).
• type : AA (significa “Active/Active”).
• critical_limit : (valor numérico).
• warning_limit : (valor numérico).

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

Descripción: Se añadirá un módulo concreto como item al clúster especificado.

Ejemplo :

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

Parámetros:

Datos JSON con estos campos:

• name : (valor de cadena de texto).
• id_cluster : (valor numérico).
• type : AP (significa “Active/Pasive”).
• critical_limit : (valor numérico).
• warning_limit : (valor numérico).

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

Descripción: Se añadirá un módulo concreto como item al clúster especificado.

Ejemplo:

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

Parámetros: <identificador_de_clúster>

Descripción: Obtiene el estado de un clúster.

Ejemplo:

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

Parámetros: <id_clúster>

Descripción: Se eliminará un clúster.

Ejemplo:

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

Parámetros: <id_agente> <id_clúster>

Descripción: Se desasociará un agente agregado a un clúster

Ejemplo:

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

Parámetros: <id_item>

Descripción: Se eliminará un item de clúster

Ejemplo:

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

Parámetros: <name> <background> <width> <height> <group> <mode> [<position_to_locate_elements> <background_color> <elements>]

Descripción: Se creará una consola visual con los parámetros especificados y sus elementos asociados. Es absolutamente necesario que los JSON vayan entre comillas simples ya que si no ocurriera podrían producirse errores en la shell desde donde se lanza el script.

Datos de interés: El modo puede adoptar los valores 'static_objects' y 'auto_creation', de la primera forma se crearán los elementos sin tener en cuenta la posición donde colocar los elementos si no que se usará la posición descrita en el propio json de elementos. Sin embargo, si el modo es 'auto_creation' se deberá establecer un tapiz de coordenadas (campo “position_to_locate_elements” con el formato que se describe en el ejemplo de abajo) y el algoritmo establecerá automáticamente la posición y tamaño de cada uno de los elementos.

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

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

Parámetros: <id> [<name> <background> <width> <height> <group> <mode> <position_to_locate_elemens> <background_color> <elements>]

Descripción: Se editará una consola visual con los parámetros especificados así como sus elementos asociados. Es absolutamente necesario que los JSON vayan entre comillas simples ya que si no ocurriera podrían producirse errores en la shell desde donde se lanza el script.

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

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

Parámetros: <id>

Descripción: Se eliminará la consola visual especificada así como sus elementos asociados.

Ejemplo:

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

Parámetros: <id> <mode> <id_mode>

Descripción: Se eliminarán los elementos asociados a una consola visual siguiendo un filtro. Los modos disponibles son “type”, “image”, “id_agent”, “id_agente_modulo”, “id_group” y “type_graph” en los que hay que especificar su identificador, que podrá ser el ID del tipo, el nombre de la imagen, el ID del agente, el ID del módulo, el id del grupo o el tipo de gráfica (area, line…).

Ejemplo:

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

Parámetros: <id> <times> [<prefix>]

Descripción: Se duplicará la consola visual indicada el número de veces deseado.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --duplicate_visual_console 1 10 'test console 2'

Parámetros: <id> [<path> <with_element_id>]

Descripción: Exporta a json una consola visual y sus elementos pudiendo especificar la ruta donde guardar el fichero y si se desea incluir el id de los elementos asociados para facilitar una posteriór edición.

Datos de interés: El campo “with_element_id” puede adoptar los valores 1 y 0, que significan con ID y sin el respectivamente.

Ejemplo:

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

Parámetros: <nombre_agente> [ use_alias ]

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

Parametros: <nombre_de_etiqueta> <descripción_de_etiqueta> [ <url_de_etiqueta> ] [ <correo_electrónico_de_etiqueta> ]

Descripción: Crea una nueva etiqueta (tag). Nombre y descripción son obligatorios.

Ejemplo:

perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_tag 'Nuevo nombre de etiqueta' 'Su descripción para la etiqueta'

Volver al Índice de Documentación Pandora FMS