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

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 tales como la creación y eliminación de un agente, un módulo o un usuario, entre otras.

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. Esto es especialmente útil cuando un parámetro tiene uno o más espacios.
• Si se necesita omitir algún parámetro se puede utilizar dos comillas simples juntas . Dado el caso el parámetro sea estrictamente necesario se mostrará un mensaje de tipo [ERROR] Error: seguido de la descripción del mismo. Esto también es útil 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 existe coincidencia el grupo será asignado.
• Se puede usar el alias de un agente, en vez de su nombre en sí mismo, por medio de el parámetro use_alias al final de la línea de comando.

Ayuda general:

pandora_manage --h | more

Para obtener ayuda sobre una opción específica se introduce la opción sin parámetros:

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

Los comandos están agrupados en las siguientes categorías:

• Agentes.
• Módulos
• Alertas
• Usuarios
• Eventos
• Políticas
• NetFlow®
• Herramientas
• Gráficas
• Clústeres
• Consolas visuales

Parámetros obligatorios (sintaxis):

• < nombre de agente > Devuelve error si el nombre existe (véase < alias como nombre >).
• < sistema operativo >
• < nombre de grupo > Debe coincidir con un SO existente (indiferente mayúsculas y minúsculas) de lo contrario quedará registrado sin grupo alguno.
• < nombre de servidor > Distingue mayúsculas y minúsculas de manera exacta, de lo contrario se dejará nulo el valor del campo sin mostrar advertencia alguna. Se debe verificar 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 de servidor > (sin importar si el servidor especificado existe o no).
• < intervalo > En segundos, valor por defecto: 300 (véase siguiente punto).
• < alias como nombre > El valor 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 se debe utilizar 0.

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 (dirección IP o nombre), una descripción y un intervalo en segundos.

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

Se creará un agente con nombre aleatorio y el alias My agent y con el periodo recomendado de 300 segundos.

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

Parámetros obligatorios (sintaxis):

• < 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 para cambiar el icono que representa al agente en los mapas GIS, los valores posibles son: circle, cross, marker, square_marker, star y triangle.
• 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'

Al cambiar la dirección IP de un agente téngase en cuenta que este comando permite repetir direcciones IP.

pandora_manage /etc/pandora/pandora_server.conf --update_agent \
    'My Agent' address 192.168.7.47

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

Para la opción disabled se debe utilizar solamente 0 y 1, cualquier otro valor producirá resultados de búsqueda y/o visualización impredecibles en la Consola web.

pandora_manage /etc/pandora/pandora_server.conf --update_agent \
    'My Agent' disabled 1 \
    use_alias

Para la opción cascade_protection se debe utilizar solamente 0 y 1, cualquier otro valor producirá resultados de búsqueda y/o visualización impredecibles en la Consola web.

pandora_manage /etc/pandora/pandora_server.conf --update_agent \
    'My Agent' cascade_protection 1 \
    use_alias

pandora_manage /etc/pandora/pandora_server.conf --update_agent \
    'My Agent' icon_path cross \
    use_alias

Parámetros obligatorios (sintaxis):

• < id_agente > identificador del agente.
• < tipo_de_campo > el cual puede ser 0 si es tipo texto o 1 si es de tipo lista desplegable (combo o combo box) compuesta de varias opciones . Véase el apartado de respuestas.
• < campo_a_cambiar > nombre del campo personalizado a actualizar.
• < valor_nuevo > el valor del campo personalizado a actualizar.

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

Las respuestas de las que se componen son:

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

• INFO:
• Actualizando el campo X con el id de agente Y.
• 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' 'THX-1138'

TIPO LISTA: se debe haber configurado un campo personalizado llamado Names con al menos un ítem llamado John.

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

Parámetros obligatorios (sintaxis):

• < nombre_agente >

Parámetro opcional:

• use_alias Se debe tener en cuenta que los alias de agente puede repetirse y se pueden borrar varios agentes con una sola orden.

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 'pandora.internals' \
    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 > opciones disponibles:

• 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 > opciones disponibles:

• 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 2 \
    'Group name' 'Web' 'transmit' 'Description'

Parámetro obligatorio:

• < nombre_de_parada_planificada >

Descripción:

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

• [ERROR] Planned_downtime cannot be stopped (la parada planificada no puede ser detenida).
• [INFO] Planned_downtime is already stopped (la parada planificada ya está detenida).
• [INFO] Stopping planned downtime (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:

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

Parámetro obligatorio:

• < nombre_de_agente >

Parámetro opcional:

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

Parámetro obligatorio:

• < nombre_de_agente >

Parámetro opcional:

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

Parámetro obligatorio:

• < nombre_de_agente >

Parámetro opcional:

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

Parámetro obligatorio: Ninguno.

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_alias para buscar a un agente por su alias en vez de su nombre.

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_alias

• Obtener todos los agentes que estén en la política de monitorización llamada Basic Linux Monitoring:

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

Parámetro obligatorio: < alias_de_agente >

Parámetro opcional: strict

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

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

pandora_manage /etc/pandora/pandora_server.conf --get_agents_id_name_by_alias 'name' strict

Parámetro obligatorio: < nombre_de_agente >

Parámetro opcional: use_alias

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

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

pandora_manage /etc/pandora/pandora_server.conf --delete_conf_file 'agent alias' use_alias

Parámetro obligatorio: < nombre_de_agente >

Parámetro opcional: use_alias

Descripción: Se limpiará el fichero de configuración de un agente (se eliminará todo el contenido del fichero, incluidos valores de conexión y parámetros de configuración).

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

pandora_manage /etc/pandora/pandora_server.conf --clean_conf_file 'agent alias' use_alias

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

1. En caso de haber ficheros corruptos y que no puedan ser abiertos:

[WARN] Can't open file < path_file >.

1. En caso de no encontrar el fichero en la ruta:

[WARN] File not exist < path_file >.

1. En caso de que los archivos de configuración estén correctos (según los tokens del primer punto):

[INFO] No bad files found

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

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

Parámetros obligatorios:

• < id_de_agente_a_migrar >
• < nombre_del_nodo_origen >
• < nombre_del_nodo_destino >

Parámetro opcional:

• < solamente_bbdd > por defecto 0, migrará los datos de la base de datos y de histórico , si está a 1 solamente migrará base de datos sin datos históricos.

Descripción: Se añade un agente a la cola de migración para mover de nodo a otro nodo.

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

pandora_manage /etc/pandora/pandora_server.conf --migration_agent_queue 1 node_1 node_2 0

Parámetro obligatorio: < id_agente_a_comprobar >

Descripción: Devolverá verdadero o falso dependiendo si el agente introducido existe en la tabla de migración de agentes.

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

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

Parámetros obligatorios (sintaxis):

• < 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 (quiet|disable_agents|disable_agents_alerts) >
• < tipo_de_ejecución (periodically|once) >
• < tipo_de_periodicidad (weekly|monthly) >
• < id_usuario >

Descripción: Se creará una parada planificada semanal o mensual con los datos enviados. El formato de fecha debe ser MM/DD/YYYY (Mes/Día/Año) para que esta llamada funcione adecuadamente.

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

pandora_manage /etc/pandora/pandora_server.con --create_downtime \
  Testing Testing 05/07/2024 06/07/2024 \
  0 1 1 1 1 11 1 17:07:00 18:08:00 1 31 \
  quiet periodically weekly admin

Parámetros obligatorios (sintaxis):

• < 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. Téngase en cuenta que el comando permite agregar ítems repetidos.

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

pandora_manage /etc/pandora/pandora_server.conf --add_item_downtime \
  1 1 Memory_Used,'CPU Load'

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 todas las paradas de servicio planificadas que coincidan con los datos enviados.

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

Para lista una parada planificada muy específica:

pandora_manage /etc/pandora/pandora_server.conf --get_all_planned_downtimes "Stop 1" "8" "disable_agents" "periodically" "monthly"

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.

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

Para obtener todos los item de todas las paradas planificadas:

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

Para obtener los item de las paradas planificadas que contenga la palabra new en mayúsculas y/o minúsculas:

pandora_manage /etc/pandora/pandora_server.conf --get_planned_downtimes_items 'new'

Para obtener los items de las paradas planificadas semanales:

pandora_manage /etc/pandora/pandora_server.conf --get_planned_downtimes_items '' '' '' '' 'weekly'

Parámetros obligatorios (sintaxis):

• < nombre_parada_planificada >

Descripción:

Borra una parada planificada por medio de su nombre correspondiente. Puede ser que responda con alguno de estos mensajes:

• This planned downtime is deleted.
• Problems with this planned downtime.
• The scheduled downtime is still being executed.

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

pandora_manage /etc/pandora/pandora_server.conf --set_planned_downtimes_deleted \
  'Name Scheduled Downtime'

Parámetros obligatorios:

• < id_de_agente >
• Para el Command Center (Metaconsola) el identificador de nodo, para los nodos se coloca 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):

Para habilitar un agente desde el nodo:

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

Para deshabilitar un agente desde nodo:

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

Para habilitar un agente desde Command Center (Metaconsola):

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

Para deshabilitar un agente desde Command Center (Metaconsola):

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

Parámetros obligatorios (sintaxis):

< identificador_numérico_de_agente >

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

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

Parámetros obligatorios (sintaxis):

• < identificador_numérico_del_agente >
• < latitud >
• < longitud >
• < altitud >

Parámetros opcionales:

• Ninguno.

Descripción: Actualiza los datos GIS de un agente. Esta característica debe de estar activada en la configuración general de PFMS.

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 (sintaxis):

• < identificador_numérico_del_agente >

Parámetros opcionales:

• Ninguno.

Descripción: Obtiene los datos GIS de un agente. Esta característica debe de estar activada en la configuración general de PFMS.

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

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

Parámetros obligatorios:

• < identificador_numérico_del_agente >
• < identificador_numérico_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 --agent_set_os 7 3 'Ubuntu 16.04'

Parámetro obligatorio: < nombre_agente >

Parámetro opcional: use_alias para buscar por alias de agente.

Descripción: Busca un agente en los nodos de un Command Center (Metaconsola) y devuelve el identificador de nodo.

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

pandora_manage /etc/pandora/pandora_server.conf --locate_agent NAS use_alias

Parámetros obligatorios:

1. < nombre_de_módulo >
2. < tipo_de_módulo >
3. < nombre_de_agente >
4. < descripción >
5. < grupo_módulo>
6. < mínimo >
7. < máximo >

Aunque los campos 4 a 5 son obligatorios, bien se pueden omitir estos parámetros utilizando comillas "". En el caso de establecer los valores mínimo y máximo aceptados por el módulo, cualquier valor fuera de este rango será descartado.

Parámetros opcionales:

1. < post_proceso >
2. < intervalo >
3. < mínimo_de_advertencia >
4. < máximo_de_advertencia >
5. < mínimo_crítico >
6. < máximo_crítico >
7. < datos_histórico >
8. < fichero_de_definición >
9. < cadena_de_advertencia >
10. < cadena_de_criticidad >
11. < habilitar_eventos_desconocidos >
12. < umbral_flip-flop >
13. < cada_flip-flop >
14. < umbral_flip-flop_normal >
15. < umbral_flip-flop_advertencia >
16. < umbral_flip-flop_crítico >
17. < tiempo_de_espera_flip-flop >
18. < inverso_de_advertencia >
19. < inverso_de_criticidad >
20. < instrucciones_de_criticidad >
21. < instrucciones_de_advertencia >
22. < instrucciones_de_estado_desconocido >
23. use_agent_alias: Para la búsqueda del agente utiliza el alias del agente en vez del nombre del agente.
24. 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.
25. < número_de_intervalos_en_advertencia > Permite el escalado de estados especificando el máximo número de intervalos seguidos en los cuales el módulo permanece en estado de advertencia. Al superar este valor el módulo escalará a estado crítico.

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

Ejemplo básico:

pandora_manage /etc/pandora/pandora_server.conf --create_data_module "My new module" "generic_data" "pandora.internals" "My description" "Miscellaneous" "0" "100"

Ejemplo sencillo para el escalado de estados:

pandora_manage /etc/pandora/pandora_server.conf --create_data_module data_module_test generic_data 3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001

Ejemplo complejo, 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:

1. < nombre_de_módulo >
2. < tipo_de_módulo > web_data, web_proc, web_content_data, web_content_string.
3. < nombre_de_agente >

En < tipo_de_módulo > los valores posibles son:

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.
37. < número_de_intervalos_en_advertencia > Permite el escalado de estados especificando el máximo número de intervalos seguidos en los cuales el módulo permanece en estado de advertencia. Al superar este valor el módulo escalará a estado crítico.

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. En el caso de establecer los valores mínimo y máximo aceptados por el módulo, cualquier valor fuera de este rango será descartado.

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

Ejemplo básico:

pandora_manage /etc/pandora/pandora_server.conf --create_web_module "My new web_content_string" "web_content_string" "pandora.internals" "My description" "Miscellaneous" "0" "100"

Ejemplo sencillo para el escalado de estados:

pandora_manage /etc/pandora/pandora_server.conf --create_web_module web_module_test web_data 3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001

Ejemplo complejo, el fichero de definición del módulo contendrá algo de este estilo:

task_begin
get http://pandorafms.com
task_end

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:

1. < nombre_modulo >
2. < tipo_modulo > acepta los siguientes valores: remote_icmp_proc, remote_icmp, remote_tcp, remote_tcp_proc, remote_tcp_string, remote_tcp_inc.
3. < nombre_agente >
4. < dirección_modulo >
5. < puerto_modulo > solamente para TCP: valor numérico entre 1 y 65535.
6. < descripción >
7. < grupo_modulo >
8. < min >
9. < max >
10. < post_process >
11. < intervalo >
12. < warning_min >
13. < warning_max >

Parámetros opcionales:

1. < critical_min >
2. < critical_max >
3. < history_data >
4. < ff_threshold >
5. < warning_str >
6. < critical_str >
7. < enable_unknown_events >
8. < each_ff >
9. < ff_threshold_normal >
10. < ff_treshold_warning >
11. < ff_threshold_critical >
12. < timeout >
13. < retries >
14. < critical_instructions >
15. < warning_instructions >
16. < unknown_instructions >
17. < warning_inverse >
18. < critical_inverse >
19. use_agent_alias para buscar el agente por su alias en vez de su nombre.
20. 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.
21. < number_of_intervals_in_warning > Permite el escalado de estados especificando el máximo número de intervalos seguidos en los cuales el módulo permanece en estado de advertencia. Al superar este valor el módulo escalará a estado crítico.

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 y otros valores opcionales.

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

Ejemplo básico:

pandora_manage /etc/pandora/pandora_server.conf --create_network_module "My Network Module" "remote_icmp_proc" "pandora.internals" "" "22" "My description" "Enviromental" "" "" "" "" "" ""

Ejemplo sencillo para el escalado de estados:

pandora_manage /etc/pandora/pandora_server.conf --create_network_module net_module_test remote_tcp 3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 127.0.0.1 "1" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001

Otro ejemplo:

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

• < network_component_name >
• < network_component_group >
• < network_component_type >

Parámetros opcionales:

• < 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 >
• < enable_unknown_events >
• < each_ff >
• <ff_threshold_normal>
• <ff_threshold_warning>
• <ff_threshold_critical>

Descripción: Se creará un componente de red. Opcionalmente se le podrá otorgar un 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 crítico mínimos y máximos, y un valor de datos histórico.

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

pandora_manage /etc/pandora/pandora_server.conf --create_network_component "example_name" 2 7

Parámetros obligatorios:

1. < module_name >
2. < module_type > son válidas las siguientes opciones: remote_snmp, remote_snmp_inc, remote_snmp_proc.
3. < agent_name >
4. < module_address >
5. < module_port > valor numérico entre 1 y 65535.
6. < version >
7. < community >
8. < oid >
9. < description >
10. < module_group >
11. < min >
12. < max >
13. < post_process >
14. < interval >

Parámetros opcionales:

1. < warning_min >
2. < warning_max >
3. < critical_min >
4. < critical_max >
5. < history_data >
6. < snmp3_priv_method >
7. < snmp3_priv_pass >
8. < snmp3_sec_level >
9. < snmp3_auth_method >
10. < snmp3_auth_user >
11. < snmp3_auth_pass >
12. < ff_threshold>
13. < warning_str >
14. < critical_str >
15. < unknown_events >
16. < each_ff >
17. < ff_threshold_normal >
18. < ff_threshold_warning >
19. < ff_threshold_critical >
20. < timeout >
21. < retries >
22. use_alias para buscar el agente por su alias en vez de su nombre.
23. 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.
24. < critical_instructions >
25. < warning_instructions >
26. < unknown_instructions >
27. < warning_inverse >
28. < critical_inverse >
29. < number_of_intervals_in_warning > Permite el escalado de estados especificando el máximo número de intervalos seguidos en los cuales el módulo permanece en estado de advertencia. Al superar este valor el módulo escalará a estado crítico.

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, la versión de SNMP, 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 de chequeo (en segundos), además de otros valores opcionales.

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

Ejemplo básico:

pandora_manage /etc/pandora/pandora_server.conf --create_snmp_module "My Module SNMP" "remote_snmp_inc" "pandora.internals" "" "777" "" "" "" "My Description" "Performance" "" "" "" ""

Ejemplo sencillo para el escalado de estados:

pandora_manage /etc/pandora/pandora_server.conf --create_snmp_module snmp_module_test remote_snmp_inc 3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 127.0.0.1 "1" "3" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001

Otro ejemplo:

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:

1. < nombre_modulo >
2. < tipo_modulo >
3. < nombre_agente >
4. < dirección_modulo >
5. < puerto_modulo > valor numérico entre 1 y 65535.
6. < nombre_plugin > uno de los registrados (menú Management → Servers → Plugins).
7. < usuario >
8. < contraseña >
9. < parámetros >
10. < descripción >
11. < grupo_modulo >
12. < min >
13. < max >
14. < post_process >
15. < intervalo >
16. < warning_min >
17. < warning_max >

Parámetros opcionales:

1. < critical_min >
2. < critical_max >
3. < history_data >
4. < ff_threshold >
5. < warning_string >
6. < critical_string >
7. < enable_unknown_events >
8. < each_ff >
9. < ff_threshold_normal >
10. < ff_threshold_warning >
11. < ff_threshold_critical >
12. < timeout >
13. < critical_instructions >
14. < warning_instructions >
15. < unknown_instructions >
16. < warning_inverse >
17. < critical_inverse >
18. use_agent_alias para buscar el agente por su alias en vez de su nombre.
19. 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.
20. < number_of_intervals_in_warning > Permite el escalado de estados especificando el máximo número de intervalos seguidos en los cuales el módulo permanece en estado de advertencia. Al superar este valor el módulo escalará a estado crítico.

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, el nombre de plugin correspondiente, una descripción, el grupo del módulo, y unos valores 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):

Ejemplo básico:

pandora_manage /etc/pandora/pandora_server.conf --create_plugin_module "My plugin module" "generic_data" "pandora.internals" "" "8080" "DNS Plugin" "" "" "" "" "" "" "" "" "" "" ""

Ejemplo sencillo para el escalado de estados:

pandora_manage /etc/pandora/pandora_server.conf --create_plugin_module plugin_module_test generic_data 3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 127.0.0.1 "1" "DNS Plugin" "admin" "pandora" "100" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001

Otro ejemplo:

pandora_manage /etc/pandora/pandora_server.conf --create_plugin_module 'My module' generic_data 'My agent' 192.168.12.123 8080 myplugin myuser mypass 'param1 param2 param3' 'Module description' 'General' 1 3 0 300 0 0 0 0 1

Parámetros opcionales:

• < nombre_grupo_módulo >

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

Respuesta: Formato CSV con cabeceras.

• id_module_group
• group_name

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

pandora_manage /etc/pandora/pandora_server.conf --get_module_group "general"

Parámetro obligatorio:

• < nombre_del_grupo >

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

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

pandora_manage /etc/pandora/pandora_server.conf --create_module_group "My module group"

Parámetro obligatorio: < nombre_servidor_1|nombre_servidor_2| … |nombre_servidor_n >

Parámetro opcional: < return_type > JSON y CSV, por defecto en formato CSV.

Descripción: Se sincronizarán los grupos de módulos de el Command Center con los nodos que hayan sido especificados en el primer parámetro, separados con |.

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

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

Parámetros:

• < nombre_modulo >
• < tipo_sintético > arithmetic o average.
• < nombre_agente >
• < opts >
• use_alias

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 operadores pueden ser: +-*/x.

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

pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module arithmetic example_agent < opts >

pandora_manage /etc/pandora/pandora_server.conf --create_synthetic example_module average example_agent < opts >

Posibles parámetros a utilizar en < opts >:

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

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ámetros (o con el alias del agente usando use_alias). En el caso de que este módulo esté en un agente local, también será eliminado del fichero de configuración. A partir de la versión 771 se eliminan de manera recursiva 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 obligatorios:

• < nombre_servidor_pfms >
• < nombre_agente >
• < nombre_modulo >
• < tipo_modulo >
• < dato_nuevo >

Parámetros opcionales:

• < fecha_hora > en formato YYY-MM-DD HH:mm.
• use_alias si se utiliza esta opción se debe especificar una fecha y hora válida.

Descripción: Inserta un valor a un módulo.

Respuestas:

• [ERROR] No module found with this type.: El tipo de módulo difiere del registrado para el módulo solicitado.
• [INFO] Inserting data to module: Respuesta exitosa.

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

pandora_manage /etc/pandora/pandora_server.conf --data_module "pandorafms" "pandorafms agent" "CPU Load" generic_data 77 "2024-07-19 13:38" use_alias

Parámetros obligatorios:

• < nombre_agente >
• < nombre_módulo >
• < intervalo > valor en segundos.

Parámetros opcionales:

• < separador > entrecomillado, de ser necesario; por defecto “|”.
• use_alias si se utiliza esta opción se debe especificar un separador.

Descripción: Se devolverán los datos de un módulo los últimos X segundos (intervalo solicitado) utilizando el separador entre timestamp y value.

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

pandora_manage /etc/pandora/pandora_server.conf --get_module_data "pandorafms agent" "CPU Load" 7200 "," use_alias

Parámetros obligatorios:

• < identificador_numérico_de_agente > si el identificador no está registrado devolverá mensaje de error indicando que el módulo solicitado no existe.
• < nombre_del_módulo >

Descripción: Se devolverá el identificador numérico de un módulo concreto de un agente.

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

pandora_manage /etc/pandora/pandora_server.conf --get_module_id 2 "CPU Load" && echo ""

Parámetros obligatorios:

• < identificador_numérico_de_módulo >
• < valor_de_identificador_personalizado >

Descripción: Inserta el valor del campo Custom ID de un módulo concreto. Si se deja en nulo “” se eliminará su contenido.

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

pandora_manage /etc/pandora/pandora_server.conf --set_module_custom_id 21 "My id value" && echo ""

Parámetro obligatorio:

• < identificador_de_módulo > (véase get_module_id).

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

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

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

Descripción: Se eliminarán del histórico de datos todos los datos asociados al objeto especificado (módulo, agente o grupo de agente).

Parámetro para borrar datos de módulo: -m < nombre_de_módulo > < nombre_de_agente >

Parámetro para borrar datos de agente: -a < nombre_de_agente > (opcional use_alias)

Parámetro para borrar datos de grupo: -g < nombre_de_grupo_de_agentes >

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

pandora_manage /etc/pandora/pandora_server.conf --delete_data -a "agent_alias" use_alias

Parámetros obligatorios:

• < nombre_de_módulo >
• < nombre_de_agente >
• < campo_a_actualizar >
• < valor_nuevo >

Parámetro opcional:

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

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

pandora_manage /etc/pandora/pandora_server.conf --update_module "CPU load" "pandorafms agent" "description" "new description"

Parámetros obligatorios:

• < nombre_de_agente >
• < nombre_de_módulo >
• < nombre_de_etiqueta >

Descripción: Adiciona una etiqueta o tag (menú Management → Profiles → Module tags) al módulo especificado.

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

pandora_manage /etc/pandora/pandora_server.conf --add_tag_to_module "pandora.internals" "console_log_size" "Dmz"

Parámetro obligatorio:

• < nombre_de_módulo >

Descripción: Obtiene el identificador de agente, su nombre y el dato actual (separados por comas) de todos los módulos con el nombre exacto solicitado (sin importar mayúsculas y/o minúsculas).

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

pandora_manage /etc/pandora/pandora_server.conf --get_agents_module_current_data "cpu load"

Parámetros obligatorios:

• < nombre_de_agente >
• < nombre_de_componente_remoto >

Parámetros opcionales:

• use_alias

Descripción: Crea un módulo en un agente dado a partir de un componente remoto. Se debe suministrar el nombre de agente o su alias con la opción use_alias.

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

pandora_manage /etc/pandora/pandora_server.conf --create_network_module_from_component "pandorafms agent" "IIS PutRequestsPersec" use_alias

Parámetros obligatorios:

• < nombre_de_agente >
• < nombre_de_componente_local >

Parámetros opcionales:

• use_alias

Descripción: Crea un módulo en un agente dado a partir de un componente local. Se debe suministrar el nombre de agente o su alias con la opción use_alias.

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

pandora_manage /etc/pandora/pandora_server.conf --create_data_module_from_local_component "pandorafms agent" "Event 1000" use_alias

Parámetros:

• < component_name >
• < data >
• < description >
• < id_os >
• < os_version >
• < id_network_component_group >
• < type >
• < min >
• < max >
• < module_interval >
• < id_module_group >
• < history_data >
• < min_warning >
• < max_warning >
• < str_warning >
• < min_critical >
• < max_critical >
• < str_critical >
• < min_ff_event >
• < post_process >
• < unit >
• < wizard_level >
• < critical_instructions >
• < warning_instructions >
• < unknown_instructions >
• < critical_inverse >
• < warning_inverse >
• < id_category >
• < disabled_types_event >
• < tags >
• < min_ff_event_normal >
• < min_ff_event_warning >
• < min_ff_event_critical >
• < each_ff >
• < ff_timeout >

Descripción: Para crear un nuevo componente local.

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

pandora_manage /etc/pandora/pandora_server.conf --create_local_component 'New local component' 'module_begin\nmodule_name name\nmodule_type generic_data\nmodule_exec exec\nmodule_end'

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

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

Parámetros obligatorios:

• < nombre_plantilla >
• < nombre_modulo >
• < nombre_agente >

Parámetros opcionales:

• use_alias

Descripción: Por medio de una plantilla se creará una alerta a un módulo de un agente.

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

pandora_manage /etc/pandora/pandora_server.conf --create_template_module "Manual alert" "CPU Load" "pandorafms agent" use_alias

Parámetros obligatorios:

• < nombre_plantilla >
• < nombre_modulo >
• < nombre_agente >

Parámetros opcionales:

• use_alias

Descripción: Se eliminará una alerta a un módulo de un agente que haya sido creada por medio de una plantilla de alerta. Devolverá respuesta solamente si los tres parámetros obligatorios existen y es exitosa la operación, de lo contrario ningún mensaje será mostrado.

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

pandora_manage /etc/pandora/pandora_server.conf --delete_template_module "Manual alert" "CPU Load" "pandorafms agent" use_alias

Si la anterior ejecución exitosa mostrará:

[INFO] Delete template 'Manual alert' from module 'CPU Load' from agent 'pandorafms agent'

Parámetros obligatorios:

• < nombre_de_acción >
• < nombre_de_plantilla >
• < nombre_de_modulo >
• < nombre_de_agente >

Parámetros opcionales:

• < mínimo_número_de_alertas >
• < máximo_número_de_alertas >
• use_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 mínimo número de alertas y máximo número de alertas (ambos por defecto 0).

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

pandora_manage /etc/pandora/pandora_server.conf --create_template_action "Mail to Admin" "Manual alert" "CPU Load" "pandorafms agent" 3 4 use_alias

Parámetros obligatorios:

• < nombre_de_acción >
• < nombre_de_plantilla >
• < nombre_de_módulo >
• < nombre_de_agente >

Parámetros opcionales:

• use_alias

Descripción: Se eliminará una acción de alerta de un módulo de agente que utilice una plantilla.

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

pandora_manage /etc/pandora/pandora_server.conf --delete_template_action "Mail to Admin" "Manual alert" "CPU Load" "pandorafms agent" use_alias

Parámetros obligatorios: Ninguno.

Parámetros opcionales: Ninguno.

Descripción: Desactiva todas las alertas. Si ya se tuvieran alertas desactivadas antes de la ejecución de este comando y luego se ejecuta su contraparte enable_alerts, todas y cada una de las alertas estarán activas de nuevo.

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

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

Parámetros obligatorios: Ninguno.

Parámetros opcionales: Ninguno.

Descripción: Activa todas las alertas. Si ya se tuvieran alertas activadas antes de la ejecución de este comando y luego se ejecuta su contraparte disable_alerts, todas y cada una de las alertas estarán inactivas de nuevo.

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

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

Parámetros:

• < template_name >
• < condition_type_serialized >
• < time_from >
• < time_to >
• < description >
• < group_name >
• < field_1 >
• < field_2 >
• < field_3 >
• < priority >
• < default_action >
• < days >
• < time_threshold >
• < min_alerts >
• < max_alerts >
• < alert_recovery >
• < field_2_recovery >
• < field_3_recovery >
• < condition_type_separator >

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

Campo < condition_type_serialized >: Son las opciones de tipo de plantilla en serie con el separador ; por defecto. Se puede cambiar el separador con el parámetro < condition_type_separator > para evitar conflictos en algunas opciones si existiera la posibilidad de que contuviesen el carácter por defecto.

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áximo y mínimo:

• 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áximo:

• Sintaxis: <type>;<max_value>
• Ejemplo: max;70 (Alerta cuando el valor es mayor de 70)

Mínimo:

• 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: on_change;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 solamente sábados y domingos.

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

pandora_manage /etc/pandora/pandora_server.conf --create_alert_template \
 "Template name" \
 "max_min@1@3@5" \
 "09:00 18:00" \
 "It sends an email when the value is in the interval 3-5, between 9 AM and 6 PM, and only on Mondays. The separator is forced to @" \
 "Unknown" \
 "[email protected]" \
 "subject" \
 "message" \
 "3" \
 "Mail to XXX" \
 "1000000" \
 "38600" \
 "1" \
 "2" \
 "0" \
 "@"

Parámetro obligatorio: < nombre_de_plantilla >

Parámetros opcionales: Ninguno.

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

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

pandora_manage /etc/pandora/pandora_server.conf --delete_alert_template "Critical condition" "" "" "" "" "" ""

Parámetros:

• < template_name >
• < field_to_update >
• < new_value >

Descripción: Se actualizará un campo dado de una plantilla de alerta existente.

Para < field_to_update > los campos posibles son:

• 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)
• field_1
• field_2
• field_3
• recovery_field_2
• recovery_field_3
• priority (0-4)
• default_action
• group_name

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

pandora_manage /etc/pandora/pandora_server.conf --update_alert_template "Template name" "priority" "4"

Parámetros obligatorios: Ninguno.

Parámetros opcionales:

• < nombre_de_acción >
• < separador >
• < formato > csv (por defecto), json, string

Descripción: Devuelve todas las acciones de las alertas. Opcionalmente se puede filtrar el resultado por palabra clave. De manera opcional en el segundo parámetro se puede especificar el separador de los resultados y en el tercer parámetro el formato del resultado.

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

pandora_manage /etc/pandora/pandora_server.jim --get_alert_actions '%28' ';' csv

Parámetros:

• < server_name >
• < action_name >
• < separator >
• < return_type>

Descripción: Devuelve todas las acciones de alerta de el Command Center (Metaconsola). Opcionalmente se puede filtrar el resultado por el nombre del nodo o por nombre de la acción. 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 (véase la llamada y su sintaxis):

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

Parámetros:

• < command_name >
• < command >
• < id_group >
• < description >
• < internal >
• < fields_descriptions >
• < fields_values >

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.
• Interno (1-0).
• Descripción de campos en el siguiente formato: [“description_1”,“description_2”,“description_3”,“description_4”,“description_5”].
• Valor de los campos en el siguiente formato: [“value_1”,“value_2”,“value_3”,“value_4”,“value_5”].

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

pandora_manage /etc/pandora/pandora_server.conf --create_alert_command \
 'Test' 'command' 'All' 'Desc' '1' \
 '["des1","des2","des3","","des5","","","","",""]' \ 
 '["val1","val2","val3","val4","","","","","",""]'

Parámetros obligatorios: Ninguno.

Parámetros opcionales:

• < nombre_de_comando >
• < comando_en_sí_mismo >
• < nombre_de_grupo >
• 1 para listar comandos de uso interno en PFMS, 0 para listar demás comandos.

Descripción: Permite ver todos los comandos de alertas. Opcionalmente se puede filtrar el resultado por palabra clave en los siguientes campos: nombre de comando, código que ejecuta el comando de alerta, nombre de grupo, descripción o si es de uso interno.

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

pandora_manage /etc/pandora/pandora_server.conf --get_alert_commands "log" "echo" "" "0"

Parámetros obligatorios:

• < nombre_de_plantilla_de_alerta >
• < id_de_agente >
• < id_de_módulo >

Parámetros opcionales:

• use_alias si se utiliza esta opción se debe colocar el alias del agente en vez de su identificador.

Descripción: Valida una alerta dados un nombre de plantilla de alerta, un ID de agente y un ID de módulo.

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

Suponiendo que está establecida una alerta en el agente que se instala por defecto con PFMS.

pandora_manage /etc/pandora/pandora_server.conf --validate_alert "Critical condition" pandora.internals 99 use_alias

Parámetros: Ninguno.

Descripción: Se validarán todas las alertas.

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

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

Parámetros:

• < special_day >
• < same_day >
• < description >
• < group_name >

Descripción: Crear un día especial.

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

pandora_manage /etc/pandora/pandora_server.conf --create_special_day "2024-05-03" "sunday" "description" "All"

Parámetros: < día_especial >

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

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

pandora_manage /etc/pandora/pandora_server.conf --delete_special_day "2024-05-03"

Parámetros:

• < special_day >
• < field_to_change >
• < new_value >

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.

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

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

Parámetros obligatorios:

• < valor > 1 para activar, 1 para desactivar.

Parámetros opcionales: Ninguno.

Descripción: Habilita o deshabilita el token Event storm protection. Si está activado no se generarán eventos ni alertas mientras se siguen recibiendo datos (chequeos de los agentes).

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

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

Parámetros obligatorios:

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

Parámetros opcionales:

• < comentario >

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 /etc/pandora/pandora_server.conf --create_user "user7500" "user 7500" "0" "This user has the password 'user 7500'"

Parámetro obligatorio:

• < id_usuario >

Descripción: Se eliminará un usuario pasado su nombre como parámetro. Este comando solamente informa del proceso de borrado,se puede verificar si un usuario existe o no mediante el comando update_user.

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 >

Los campos disponibles para < campo_a_actualizar > son:

1. email : correo electrónico.
2. phone : número de teléfono.
3. is_admin : ¿Es superadmin? (0 falso,1 verdadero).
4. comments : Comentarios.
5. fullname : Nombre completo del usuario.
6. password : Contraseña del usuario, utilice comillas si contiene espacios.
7. language idioma, valores posibles:

• default, toma el idioma seleccionado en la configuración general.
• ca, catalán.
• en_GB, inglés Reino Unido.
• es, español.
• fr, francés.
• ru, ruso.
• ja, japonés.
• zh_CN, chino simplificado.

Descripción: A un usuario existente le actualiza el campo dado.

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

pandora_manage /etc/pandora/pandora_server.conf --update_user "usuario 7500" 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 /etc/pandora/pandora_server.conf --enable_user "user7500"

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 /etc/pandora/pandora_server.conf --disable_user "user7500"

Parámetros obligatorios:

• < nombre_perfil >
• < lista_de_permisos > 1 para otorgar permiso al nuevo perfil o 0 para negarlo, en este orden:

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 perfil nuevo pasando como parámetros el nombre del perfil y los permisos.

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

pandora_manage /etc/pandora/pandora_server.conf --create_profile "New profile" 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 > 1 para otorgar permiso al nuevo perfil o 0 para negarlo, en este orden:

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 pasando como parámetros el nombre del perfil y los permisos.

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

pandora_manage /etc/pandora/pandora_server.conf --update_profile "New profile" 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 pasando como parámetro el identificador 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.

Comando relacionado: add_profile_to_user.

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

pandora_manage /etc/pandora/pandora_server.conf --add_profile "User 07" "Group coordinator" "All"

Parámetros obligatorios:

• < id_usuario >
• < nombre_de_etiqueta >
• < nombre_de_grupo >
• < nombre_de_perfil >

Descripción: Al perfil y grupo asignado a un usuario le agrega una etiqueta.

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

pandora_manage /etc/pandora/pandora_server.conf --add_tag_to_user_profile 'User 7500' 'dmz' 'Servers' 'Chief Operator'

Parámetros obligatorios:

• < id_usuario >
• < nombre_perfil >
• < nombre_grupo >

Descripción: Se eliminará un perfil de un usuario pasando como parámetro el nombre de usuario, el nombre del perfil y el nombre del grupo sobre el que tiene los privilegios el perfil.

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

pandora_manage /etc/pandora/pandora_server.conf --delete_profile "User 07" "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.

Comando relacionado: add_profile.

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 EACL será desactivado en la configuración general de PFMS.

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

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

Parámetros: Ninguno.

Descripción: El sistema EACL será activado en la configuración general de PFMS.

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

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

Parámetro obligatorio:

• < id_usuario >

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

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

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

Parámetros obligatorios:

• < nombre_de_etiqueta >
• < descripción_de_etiqueta > se puede utilizar comillas simples o dobles para una descripción nula.

Parámetros opcionales:

• < url_de_etiqueta > si se utiliza una cadena cualquiera abrirá un enlace en la Consola web.
• < correo_electrónico_de_etiqueta >

Descripción: Crea una nueva etiqueta.

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

pandora_manage /etc/pandora/pandora_server.conf --create_tag "New tag" "My description" "index.php?sec=custom_report&sec2=godmode/reporting/reporting_builder"

pandora_manage /etc/pandora/pandora_server.conf --create_tag "New tag" "My description" "https://example.com" "[email protected]"

Parámetros obligatorios (3):

• < nombre_de_evento >
• < tipo_de_evento > Podrá tomar uno de estos valores tipificados:

• < nombre_de_grupo >

Parámetros opcionales:

1. Nombre del agente.
2. Nombre del módulo.
3. Estado del evento (0 si no está validado, 1 si está validado y 2 en proceso).
4. Severidad: 0 (Mantenimiento), 1 (Informativo), 2 (Normal), 3 (Advertencia), 4 (Crítica), 5 (Menor) y 6 (Mayor).
5. Nombre de la plantilla en el caso de que esté asociado a una alerta.
6. Nombre de usuario.
7. Comentario.
8. Fuente.
9. Identificador adicional.
10. 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.
11. Datos personalizados: Los datos personalizados se introducen como un documento JSON. Por ejemplo: {“Location”: “Office”, “Priority”: 42} .
12. 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.
13. Instrucciones en crítico: Añade las instrucciones a realizar en caso de pasar a estado crítico.
14. Instrucciones en advertencia: Añade las instrucciones a realizar en caso de pasar a estado de advertencia.
15. Instrucciones en desconocido: Añade las instrucciones a realizar en caso de pasar a estado desconocido.
16. 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.
17. Command Center (Metaconsola): Identificador del servidor.

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

• < nombre_de_agente >

Parámetros opcionales:

• < nombre_módulo >
• < fecha_hora_mínima >
• < fecha_hora_máxima >
• < usuario_dueño_de_evento >
• < id_criticidad > Uno de estos valores: 0 (maintenance), 1 (informational), 2 (normal), 3 (warning), 4 (critical), 5 (minor).
• < nombre_plantilla >
• use_alias si se desconoce el nombre del agente se puede buscar por su 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 y hora mínima y una fecha y hora máxima, el nombre del usuario dueño del evento, el identificador de criticidad y el nombre de la plantilla asociada.

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

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

pandora_manage /etc/pandora/pandora_server.conf --validate_event 'My agent' 'My module'  '2024-06-02 22:02'

Parámetros obligatorios: < id_evento >

Parámetros opcionales: Ninguno.

Descripción: Permite validar un evento mediante su identificador entero numérico.

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

pandora_manage /etc/pandora/pandora_server.conf 1234

Parámetro obligatorio:

• < id_evento >

Parámetro opcional:

• < separador > por defecto |.

Descripción: Se mostrará la información de un evento dado su identificador.

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

pandora_manage /etc/pandora/pandora_server.conf --get_event_info 341

Parámetros obligatorios:

• < id_evento >
• < id_usuario >
• < comentario >

Descripción: Añade un comentario a un evento especificando un usuario registrado.

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

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

Parámetro obligatorio: < id_evento >

Descripción: Cambia el estado de un evento a “En progreso” mediante su identificador numérico.

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

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

• < nuevo_nombre_de_política >
• < nombre_de_grupo_de_agentes >

Parámetro opcional:

• < descripción >

Descripción: Se creará una política con el nombre especificado y perteneciente al grupo también especificado.

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

pandora_manage /etc/pandora/pandora_server.conf --create_policy "New policy" "Workstations" "All desktop computers."

Parámetros obligatorios:

• < id_numérico_de_política > Si se omiten los parámetros opcionales, se aplicará la política a todos los agentes que pertenezcan a ella.

Parámetros opcionales:

1. < id_numérico_de_agente >
2. < usar_id_numérico > por defecto 0, para utilizar el nombre de agente en el parámetro opcional uno se debe especificar 1 en este parámetro.
3. < id_servidor > Si se está trabajando en un entorno centralizado este parámetro debe ser especificado, indicando el servidor al cual se ejecutará y aplicará la política de monitorización.

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.

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

pandora_manage /etc/pandora/pandora_server.conf --apply_policy 6 1 0 1

Parámetros: Ninguno.

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 de monitorización.

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

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

Parámetros obligatorios:

• < nombre_de_agente >
• < nombre_de_política >

Parámetro opcional:

• use_alias

Descripción: Se agregará un agente existente a una política existente especificando su nombre de agente o, si se utiliza el parámetro opcional, su alias de agente.

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

pandora_manage /etc/pandora/pandora_server.conf --add_agent_to_policy "pandorafms agent" "Basic Linux Monitoring" use_alias

Parámetros obligatorios:

• < nombre_de_política >
• < nombre_de_colección >

Parámetros opcionales: Ninguno.

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

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

pandora_manage /etc/pandora/pandora_server.conf --add_collection_to_policy "Basic Remote Checks" "Apache Enterprise Plugin"

Parámetro obligatorio: < id_de_colección_de_ficheros >

Parámetros opcionales: Ninguno.

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

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

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

Parámetros:

• < policy_name >
• < component_name >

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

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

pandora_manage /etc/pandora/pandora_server.conf \
 --create_policy_data_module_from_local_component \
 "Monitoring policy name" \
 "Local component name"

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

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

Parámetros obligatorios:

• < id_de_política >
• < id_de_agente >

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

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

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

Parámetro obligatorio: < nombre_de_política >

Parámetro opcional: Ninguno.

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

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

pandora_manage /etc/pandora/pandora_server.conf --disable_policy_alerts "Basic HP-UX Local Monitoring"

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 (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 > web_data, web_proc, web_content_data, web_content_string.

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'

Parámetro obligatorio: < nombre_de_política >

Parámetros opcionales: Ninguno.

Descripción: Valida todas las alertas de una política dada.

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

pandora_manage /etc/pandora/pandora_server.conf --validate_policy_alerts "Basic Linux Monitoring"

Parámetro obligatorio: < nombre_de_política >

Parámetros opcionales: Ninguno.

Descripción: Obtiene la lista de módulos (identificador numérico y nombre) de una política dada.

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

pandora_manage /etc/pandora/pandora_server.conf --get_policy_modules "Basic Linux Monitoring"

Parámetros obligatorios: Ninguno.

Parámetros opcionales:

• < nombre_de_agente >
• use_alias para buscar por alias de agente.

Descripción:

• Sin parámetros: Obtiene todas las políticas (identificador numérico y nombre).
• Nombre de agente: Obtiene las políticas de un agente (lista nombre de agente, identificador numérico de política y nombre de política).

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

pandora_manage /etc/pandora/pandora_server.conf --get_policies "pandorafms agent" use_alias

Parámetros obligatorios:

• < nombre_nuevo_filtro >
• < nombre_de_grupo_de_agentes >
• < filtro_como_tal >
• < agregados_por > Uno de los siguientes valores: none, dstip, dstport, proto, srcip, srcport.
• < formato_de_salida > kilobytes, kilobytespersecond, megabytes, megabytespersecond.

Parámetros opcionales: Ninguno.

Descripción: Crear un nuevo filtro para monitorizar vía NetFlow®.

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

pandora_manage /etc/pandora/pandora_server.conf --create_netflow_filter "New filter" "Network" "host 192.168.50.3 OR host 192.168.50.4 or HOST 192.168.50.6" dstport kilobytes

Parámetros obligatorios (véase caso práctico):

• < comando_a_ejecutar >
• < parámetros_del_comando_a_ejecutar >

Descripción: Con esta opción es posible ejecutar cualquier comando del CLI PFMS 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__, … , __FIELDn__.

Caso práctico:

Registrar usuarios con el comando create_user desde un fichero CSV /tmp/users_csv:

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

Sentencia a ejecutar (se incluyen conectores de línea con propósito didáctico):

pandora_manage /etc/pandora/pandora_server.conf --exec_from_file \
  /tmp/users_csv \
  create_user \
  __FIELD1__ \
  __FIELD2__ \
  __FIELD3__ \
  'Created by exec_from_file CLI PFMS command'

Parámetros obligatorios:

• < nombre_de_snmp_trap > Tal como se verá en la consola de SNMP traps.
• < OID >
• < descripción >
• < severidad > Valor numérico, uno de los siguientes valores: 0 (Maintenance), 1 (Info) , 2 (Normal), 3 (Warning), 4 (Critical), 5 (Minor), 6 (Major).

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

pandora_manage /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 SNMP. 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 ubicado por defecto en:

/var/log/pandora/pandora_snmptrapd.log

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

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

Parámetro obligatorio:

• < nombre_de_servidor_PFMS >

Parámetros opcionales: Ninguno.

Descripción: Se debe tener activada la opción multiprocess para que los servidores PFMS se ejecuten en procesos individuales y puedan ser detectados por este comando. Una vez realizada esta configuración, al usar este comando sin parámetros se listará los servidores en ejecución y con sus nombres correspondientes para ser finalizados, uno a uno.

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

pandora_manage /etc/pandora/pandora_server.conf --kill dataserver

Parámetros obligatorios:

• < nombre_de_nueva_gráfica >
• < descripción >
• < id_usuario >
• < id_grupo >
• < ancho >
• < altura >
• < eventos >
• < tipo_de_gráfica > Por defecto 0 (Área) o uno de los siguientes valores:

1. Área apilada.
2. Línea.
3. Línea apilada.
4. Gráfico de puntos.
5. Calibrador.
6. Barras horizontales.
7. Barras verticales.
8. Gráfico circular.

• < período >
• < módulos >
• < separador_de_módulos >

Descripción: Se creará una gráfica con los elementos especificados. Dos o más módulos deben ser distinguidos con < separador_de_módulos >, el cual siempre debe ser especificado, incluso para un solo módulo.

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

pandora_manage /etc/pandora/pandora_server.conf --create_custom_graph "New graph" "Graph created by CLI PFMS" "admin" "0" "" "" "0" "2" "" "1;2;3" ";"

Parámetros obligatorios:

• < id_gráfica_a_editar >
• < nombre_de_gráfica_a_editar >
• < descripción_a_editar >
• < usuario_a_editar >
• < id_grupo_a_editar >
• < ancho_a_editar >
• < altura_a_editar >
• < eventos_a_editar >
• < tipo_de_gráfica_a_editar > Por defecto 0 (Área) o uno de los siguientes valores:

1. Área apilada.
2. Línea.
3. Línea apilada.
4. Gráfico de puntos.
5. Calibrador.
6. Barras horizontales.
7. Barras verticales.
8. Gráfico circular.

• < período_a_editar >

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

pandora_manage /etc/pandora/pandora_server.conf --edit_custom_graph "1" "" "edit graph by CLI" "" "" "" "" "" "" "" 3600

Parámetros obligatorios:

1. < id_gráfica >
2. < id_módulos > hasta un máximo de 10 módulos, delimitados con < separador >
3. < separador >

Descripción: Se añadirán los módulos especificados en la gráfica seleccionada. Aunque se pueden agregar más de 10 módulos, solamente serán visualizados los 10 primeros.

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

pandora_manage /etc/pandora/pandora_server.conf --add_modules_to_graph 1 '1,2,3' ','

pandora_manage /etc/pandora/pandora_server.conf --add_modules_to_graph 1 '4;5;6;7' ';'

Parámetros obligatorios:

• < id_gráfica >
• < id_módulos > los identificadores numéricos de módulos deben ir delimitados con < separador >
• < separador >

Descripción: Se eliminarán los módulos especificados de la gráfica seleccionada.

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

pandora_manage.pl /etc/pandora/pandora_server.conf --delete_modules_to_graph "1" "2,4,6" ","

Parámetros obligatorios:

• < nombre_clúster >
• < tipo_clúster > solamente AA o AP.
• < descripción >
• < id_grupo >

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

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

pandora_manage /etc/pandora/pandora_server.conf --new_cluster \
 "New cluster" "AA" "My description" "2"

Parámetro obligatorio:

• < json_data_base64 > en formato JSON, codificado luego en base 64: pares de valores con el identificador de clúster y el identificador de agente. Ejemplo:

[{"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 datos JSON se codifiquen en base 64.

Continuación del ejemplo anterior (véase la llamada y su sintaxis):

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

Continuación del ejemplo anterior (véase la llamada y su sintaxis):

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

Parámetro obligatorio:

Datos JSON con estos campos:

• name: (valor de cadena de texto).
• id_cluster: (valor numérico).
• type: AP (significa “Active/Passive”).
• 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.

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

Parámetro obligatorio: < identificador_de_clúster >

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

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

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

Parámetro obligatorio: < id_clúster >

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

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

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

Parámetros obligatorios:

• < id_agente >
• < id_clúster >

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

Example (see call and syntax):

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

Parámetro obligatorio:

• < id_item >

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

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

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

Parámetros obligatorios:

1. < nombre >
2. < imagen_de_fondo > uno de los ficheros ubicados en …/pandora_console/images/console/background/.
3. < ancho >
4. < altura >
5. < nombre_de_grupo >
6. < modo > static_objects o auto_creation: De la primera forma se crearán los elementos sin tener en cuenta la posición donde colocar los elementos (se usará la posición descrita en el propio JSON de elementos), véase caso práctico 1. Si el modo es auto_creation se deberá establecer un tapiz de coordenadas (campo < posición_para_localizar_elementos > ) y el algoritmo establecerá automáticamente la posición y tamaño de cada uno de los elementos, véase caso práctico 2.

Parámetros opcionales:

• < posición_para_localizar_elementos >
• < color_de_fondo > en formato hexadecimal.
• < elementos > en formato JSON. Es absolutamente necesario que los parámetros en JSON vayan entre comillas simples para poder incluir las comillas dobles de dichos datos.

Descripción: Se creará una Consola Visual con los parámetros especificados y sus elementos asociados.

"id_layout_linked_weight": 0, "element_group": 0,"show_on_top":0

Ejemplo con auto_creation y conectores de líneas (véase la llamada y su sintaxis):

pandora_manage /etc/pandora/pandora_server.conf --create_visual_console \
 'Visual Console test 1' \
 'map-africa.png' \
 '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","id_layout_linked_weight": 0, "element_group": 0,"show_on_top":0},{"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","id_layout_linked_weight": 0, "element_group": 0,"show_on_top":0}]'

Se ilustra el segundo JSON:

[
  {
    "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",
    "id_layout_linked_weight": 0,
    "element_group": 0,
    "show_on_top": 0
  },
  {
    "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",
    "id_layout_linked_weight": 0,
    "element_group": 0,
    "show_on_top": 0
  }
]

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

pandora_manage /etc/pandora/pandora_server.conf --create_visual_console \
 'Visual Console test 2' \
 'mapa-asia.png' \
 '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","id_layout_linked_weight": 0, "element_group": 0,"show_on_top":0},{"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","id_layout_linked_weight": 0, "element_group": 0,"show_on_top":0}]'

Se ilustra el último JSON:

[
  {
    "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",
    "id_layout_linked_weight": 0,
    "element_group": 0,
    "show_on_top": 0
  },
  {
    "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",
    "id_layout_linked_weight": 0,
    "element_group": 0,
    "show_on_top": 0
  }
]

Consola visual con todos los elementos disponibles:

pandora_manage /etc/pandora/pandora_server.conf --create_visual_console \
"Visual Console with all elements" \
"map-southamerica.png" \
1024 \
768 \
12 \
"static_objects" \
"" \
"#000000" \
'[{"id":69,"image":"network","pos_y":8,"pos_x":7,"width":70,"height":70,"label":"","type":0,"period":3600,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":0,"type_graph":"area","label_position":"down","border_color":"","fill_color":"","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":70,"image":"percent","pos_y":9,"pos_x":123,"width":100,"height":0,"label":"","type":15,"period":3600,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":0,"type_graph":"area","label_position":"down","border_color":"#000000","fill_color":"#bcbcbc","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":71,"image":"white","pos_y":9,"pos_x":239,"width":300,"height":180,"label":"","type":1,"period":3600,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":0,"type_graph":"area","label_position":"down","border_color":"","fill_color":"","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":72,"image":"","pos_y":0,"pos_x":614,"width":394,"height":175,"label":"","type":23,"period":3600,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":0,"type_graph":"area","label_position":"down","border_color":"#000000","fill_color":"","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":73,"image":"","pos_y":197,"pos_x":14,"width":300,"height":300,"label":"","type":17,"period":3600,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":0,"type_graph":"area","label_position":"down","border_color":"#ffffff","fill_color":"","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":74,"image":"white","pos_y":198,"pos_x":354,"width":300,"height":180,"label":"","type":18,"period":3600,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":0,"type_graph":"horizontal","label_position":"down","border_color":"#000000","fill_color":"","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":75,"image":"","pos_y":398,"pos_x":481,"width":500,"height":70,"label":"","type":14,"period":86400,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":0,"type_graph":"area","label_position":"down","border_color":"#000000","fill_color":"","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":76,"image":"string","pos_y":510,"pos_x":9,"width":0,"height":0,"label":"(_value_)","type":2,"period":300,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":0,"type_graph":"area","label_position":"down","border_color":"","fill_color":"","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":77,"image":"","pos_y":511,"pos_x":76,"width":50,"height":50,"label":"","type":4,"period":3600,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":0,"type_graph":"area","label_position":"down","border_color":"","fill_color":"","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":78,"image":"http://192.168.7.117/pandora_console/images/console/icons/appliance.png","pos_y":510,"pos_x":162,"width":70,"height":70,"label":"","type":5,"period":3600,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":0,"type_graph":"area","label_position":"down","border_color":"","fill_color":"","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":79,"image":"","pos_y":513,"pos_x":253,"width":100,"height":50,"label":"","type":19,"period":3600,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":0,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":0,"type_graph":"area","label_position":"down","border_color":"#000000","fill_color":"#000000","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":80,"image":"appliance","pos_y":515,"pos_x":343,"width":70,"height":70,"label":"","type":11,"period":3600,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":0,"type_graph":"area","label_position":"down","border_color":"","fill_color":"","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":81,"image":"","pos_y":495,"pos_x":445,"width":100,"height":100,"label":"","type":12,"period":3600,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":1,"type_graph":"area","label_position":"down","border_color":"#000000","fill_color":"#ffffff","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":82,"image":"","pos_y":158,"pos_x":91,"width":42,"height":43,"label":"","type":13,"period":3600,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":1,"type_graph":"area","label_position":"down","border_color":"#000000","fill_color":"","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":83,"image":"","pos_y":488,"pos_x":562,"width":169,"height":183,"label":"{\"default_color\":\"#000000\",\"color_ranges\":[]}","type":20,"period":3600,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":0,"type_graph":"area","label_position":"down","border_color":"#000000","fill_color":"","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":84,"image":"","pos_y":533,"pos_x":755,"width":909,"height":560,"label":"{\"labelStart\":null,\"labelEnd\":null,\"linkedStart\":null,\"linkedEnd\":null}","type":21,"period":3600,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":5,"type_graph":"area","label_position":"down","border_color":"#000000","fill_color":"","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":85,"image":"","pos_y":0,"pos_x":0,"width":300,"height":150,"label":"","type":22,"period":3600,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":0,"type_graph":"area","label_position":"down","border_color":"#000000","fill_color":"","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":86,"image":"","pos_y":583,"pos_x":864,"width":140,"height":56,"label":"","type":10,"period":3600,"id_agente_modulo":0,"id_agent":0,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":0,"type_graph":"area","label_position":"down","border_color":"","fill_color":"","id_layout_linked_weight":0,"element_group":0,"show_on_top":0},{"id":90,"image":"","pos_y":271,"pos_x":791,"width":116,"height":44,"label":"","type":22,"period":3600,"id_agente_modulo":129,"id_agent":3,"id_layout_linked":0,"parent_item":0,"enable_link":1,"id_metaconsole":0,"id_group":0,"id_custom_graph":0,"border_width":0,"type_graph":"area","label_position":"down","border_color":"#000000","fill_color":"","id_layout_linked_weight":0,"element_group":0,"show_on_top":0}]'

Parámetros obligatorios (véase la descripción con los detalles):

• < id_numérico_de_consola_visual_a_modificar >
• < nombre >
• < imagen_de_fondo >
• < ancho >
• < altura >
• < nombre_de_grupo >
• < modo >
• < posición_para_localizar_elementos >
• < color_de_fondo >
• < elementos >

Parámetros opcionales: Ninguno.

Descripción: Funciona de manera conjunta con el comando export_json_visual_console y permite editar una consola visual existente y sus elementos. Dicho comando muestra por pantalla los datos completos de una consola visual registrada lo cual puede ser copiado y pegado para ser modificado.

A continuación de haber invocado edit_visual_console y el identificador numérico de la consola visual a modificar se puede pegar el texto modificado.

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

• Creación de una consola visual sin elementos.

pandora_manage /etc/pandora/pandora_server.conf --create_visual_console \
 "My Visual Console" \
 "None.png" \
 1024 \
 768 \
 9 \
 "static_objects" \
 "" \
 "#ffffff" \
 '[]'

Devolverá algo parecido a esto (se debe tomar nota del identificador numérico, en este caso 14):

 [*] DB Host is 127.0.0.1
[INFO] Creating visual console 'My Visual Console'

[INFO] The visual console id is '14'

[root@pandorafms ~]#

• Exportar el código con el comando export_json_visual_console, es importante que el último parámetro esté configurado a uno para obtener así los identificadores numéricos de cada uno de los elementos (aunque en este caso ningún item está registrado).

pandora_manage /etc/pandora/pandora_server.conf --export_json_visual_console "14" "" "1"

Devolverá algo parecido a esto (se debe copiar la línea completa debajo del segundo mensaje informativo [INFO]):

 [*] DB Host is 127.0.0.1
[INFO] Exporting visual console elements with ID '14'

[INFO] JSON file now contents:
"My Visual Console" "None.png" 1024 768 9 "static_objects" "" "#ffffff" '[]'

[root@pandorafms ~]#

• Invocar el comando edit_visual_console, un espacio, el identificador de consola visual, otro espacio y pegar el código obtenido en el paso anterior. Modificar el nombre (u otro elemento o elementos).

pandora_manage /etc/pandora/pandora_server.conf --edit_visual_console \
 "14" \
 "My MODIFIED Visual Console" \
 "None.png" \
 1024 \
 768 \
 9 \
 "static_objects" \
 "" \
 "#ffffff" \
 '[]'

Devolverá algo parecido a lo siguiente:

 [*] DB Host is 127.0.0.1
[INFO] The visual console with id 14 is updated

[root@pandorafms ~]#

Se puede confirmar por la Consola web PFMS o bien invocar de nuevo el comando export_json_visual_console.

Parámetro obligatorio:

• < id_consola_visual >

Descripción: Se eliminará la consola visual especificada por medio de su identificador numérico, en caso de especificar una consola visual inexistente arrojará mensaje de error.

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

pandora_manage /etc/pandora/pandora_server.conf --delete_visual_console "1"

Parámetros obligatorios:

• < id_item >
• < filtro >
• < valor_de_filtro >

Descripción: Se eliminarán los elementos asociados a una consola visual siguiendo un filtro. Los filtros disponibles son:

• image para eliminar todos los item que tengan un nombre exacto de imagen.
• id_agent para borrar todos los item que tengan un identificador numérico de agente en particular.
• id_agente_modulo para eliminar todos los item que tengan un identificador numérico de módulo en particular.
• id_group para borrar todos los item que pertenezcan a un identificador numérico de grupo de agentes específico. Por defecto, y a menos que se hayan modificado, todos los item pertenecen al grupo All identificado con el valor 0, especificar este valor borrará la mayoría de los elementos.
• type_graph para eliminar todos los item que tengan un tipo de gráfico en particular. Por defecto, y a menos que se hayan modificado, todos los item tienen establecido el valor area, especificar este valor borrará la mayoría de los elementos.
• type para eliminar todos los item por su tipo de elemento:

• 0 Static image.
• 1 Module Graph.
• 2 Simple value.
• 4 Label.
• 5 Icon.
• 10 Service.
• 11 Group.
• 12 Box.
• 13 Line.
• 14 Event history graph.
• 15 Percentile item.
• 17 Serialized pie graph.
• 18 Bars graph.
• 19 Clock.
• 20 Color cloud.
• 21 Network link.
• 22 Odometer.
• 23 Basic Chart.

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

Para borrar todos los items que contengan la imagen network en la consola visual 1:

pandora_manage /etc/pandora/pandora_server.conf --delete_visual_console_objects \
 "1" image "network"

Para eliminar todos los items que muestren al agente 3 en la consola visual 1:

pandora_manage /etc/pandora/pandora_server.conf --delete_visual_console_objects \
 "1" id_agent "3"

Para borrar todos los items que representen al módulo 2 en la consola visual 1:

pandora_manage /etc/pandora/pandora_server.conf --delete_visual_console_objects \
 "1" id_agente_modulo "2"

Para eliminar todos los items pertenezcan al grupo 4 en la consola visual 1:

pandora_manage /etc/pandora/pandora_server.conf --delete_visual_console_objects \
 "1" id_group "4"

Para borrar todos los items que usen el tipo de gráfica horizontal en la consola visual 1:

pandora_manage /etc/pandora/pandora_server.conf --delete_visual_console_objects \
 "1" type_graph "horizontal"

Para eliminar todos los items de tipo Odometer (22) en la consola visual 1:

pandora_manage /etc/pandora/pandora_server.conf --delete_visual_console_objects \
 "1" type "22"

Parámetros obligatorios:

• < id_consola_visual_a_copiar >
• < número_de_copias > se agregará el sufijo _n desde 1 hasta n.

Parámetro opcional:

• < prefijo > se agregará como prefijo y además el sufijo _n desde 0 hasta n-1.

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

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