====== Interfaz de Línea de Comandos (CLI) ======
{{indexmenu_n>3}}
\\
Estamos trabajando en la traducción de la documentación de Pandora FMS. Disculpen las molestias.\\
( Consulte la versión en [[:en:documentation:pandorafms:technical_reference:03_anexo_cli|inglés original en este enlace]].)\\
===== CLI de Pandora FMS =====
La CLI (//Command-Line Interface// o Interfaz de Línea de Comandos) de Pandora FMS se utiliza haciendo llamadas en línea de comandos sobre el fichero:
/usr/share/pandora_server/util/pandora_manage.pl
Este método es especialmente útil para integrar aplicaciones de terceros con Pandora FMS mediante tareas automatizadas. Básicamente consiste en un llamada con los parámetros formateados para realizar una acción como la creación y eliminación de un agente, un módulo o un usuario, entre otras.
**Versión Community**:
El CLI es un fichero en Perl:
perl pandora_manage.pl
Con la barra inversa ''\'' como conector de líneas:
perl pandora_manage.pl \
\
**Versión Enterprise**:
Si es un usuario **Enterprise** deberá utilizar el binario ejecutable en lugar del archivo ''.pl'', debido a que ciertas funcionalidades Enterprise podrían no funcionar correctamente con el fichero tipo ''.pl''. Puede ejecutar directamente ''pandora_manage'' para comenzar.
pandora_manage
Con la barra inversa ''\'' como conector de líneas:
pandora_manage \
\
Todos los ejemplos mostrados aquí, a menos que se explícitamente se especifique otra cosa, se refieren a la versión **Enterprise** ( ''pandora_manage'' ).
==== Sintaxis ====
* Todos los parámetros, obligatorios u opcionales, pueden ser delimitados con comillas simples.
* El entrecomillado es especialmente útil cuando un parámetro tiene espacios, por ejemplo '''Mi Agente'''.
* También si necesita omitir algún parámetro obligatorio puede utilizar dos comillas simples juntas . Dado el caso sea estrictamente necesario se mostrará un mensaje ''[ERROR] Error:'' seguido de la descripción del error. **En el caso de los parámetros opcionales**, si son varios y necesita especificar solamente el segundo y/o tercero y/o etcétera, utilice dos comillas simples juntas para indicar los parámetros opcionales vacíos.
* Algunos parámetros diferencian entre mayúsculas y minúsculas, otros son indiferentes. Por ejemplo, [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#create_agent|al crear un agente]] el nombre del servidor PFMS debe ser estrictamente igual, sin embargo el nombre del grupo primario al cual pertenecerá el agente puede estar en mayúsculas y/o minúsculas y si hay coincidencia el grupo será asignado.
* Se puede usar el alias de un agente, en vez de su nombre en sí, por medio de el parámetro ''use_alias'' **al final de la línea** de comando.
==== Ayuda ====
Para obtener la ayuda general del CLI de Pandora FMS use:
pandora_manage --h
Para obtener ayuda sobre una opción específica solo escriba la opción sin parámetros; por ejemplo para crear un usuario:
pandora_manage /etc/pandora/pandora_server.conf --create_user
===== Agentes =====
==== create_agent ====
**Parámetros obligatorios:**
* < nombre_agente >
* < sistema_operativo >
* Puede omitirse por medio de dos comillas simples juntas.
* < nombre_grupo >
* < nombre_servidor >
* Distingue mayúsculas y minúsculas de manera exacta, de lo contrario se dejará nulo el valor del campo //sin mostrar advertencia alguna//. **Asegúrese de que el agente haya sido asignado a un servidor.**
**Parámetros opcionales:**
* < dirección IP o URL >
* < descripción >
* Si omite la descripción será agregado ''Created by < nombre_servidor >''.
* < intervalo >
* < alias como nombre >
**Descripción:**
Se creará un agente con el nombre, el sistema operativo, el grupo y el servidor especificados. Opcionalmente se le podrá otorgar una dirección (IP o nombre), una descripción y un intervalo en segundos (por defecto 300).
El parámetro < alias como nombre > por defecto es ''1'' y con ese valor el alias del agente será igual que el nombre del agente. Si se desea que el nombre sea generado de forma aleatoria hay que poner este parámetro a ''0''. Si alguno de los tres primeros parámetros opcionales debe ser omitido utilice comillas simples juntas por cada omisión.
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --create_agent \
'My agent' AIX Databases Central-Server \
192.168.12.123 'Agent description' '' 0
==== update_agent ====
**Parámetros obligatorios:**
* < nombre_del_agente >
* < campo_a_modificar >
* < nuevo_valor >
**Parámetros opcionales:**
* ''use_alias''
**Descripción:** Se actualizará un de un agente existente. Los campos disponibles son los siguientes:
* ''agent_name''
* ''address''
* ''description''
* ''group_name''
* ''interval''
* ''os_name''
* ''disabled'' ( ''0'' para activarlo, ''1'' para inactivarlo).
* ''parent_name''
* ''cascade_protection'' ( ''0'' para inactivarlo, ''1'' para activarlo).
* ''icon_path''
* ''update_gis_data'' ( ''0'' para inactivarlo, ''1'' para activarlo).
* ''custom_id''
Para identificar al agente por medio de su alias en vez de su nombre, utilice ''use_alias'' justo al final.
**Ejemplos (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --update_agent \
'My Agent' agent_name 'Agent 2'
pandora_manage /etc/pandora/pandora_server.conf --update_agent \
'My Agent' description 'New note' \
use_alias
==== agent_update_custom_fields ====
Versión NG 758 o posterior.\\
**Parámetros:**
- ''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 compuesta de varias opciones (//combo// o //combo box//). Véase el apartado de respuestas. Ejemplo si existe:{{ :wiki:pfms-pandorafms:technical_reference-03_anexo_cli-agent_update_custom_fields-img01.png }}
- ''campo_a_cambiar'' → nombre del campo a actualizar.
- ''valor_nuevo'' → el valor del campo a actualizar.
**Descripción:** actualiza los campos personalizados (//custom fields//) de un agente.
Las respuestas de las que se componen son:
* **ERROR**:
- 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 [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
TIPO TEXTO:
pandora_manage /etc/pandora/pandora_server.conf --agent_update_custom_fields 1 0 'Serial number' 'john'
{{ :wiki:pfms-pandorafms:technical_reference-03_anexo_cli-agent_update_custom_fields-img02.png }}
TIPO COMBO:
pandora_manage /etc/pandora/pandora_server.conf --agent_update_custom_fields 1 1 'Nombres' 'Juan'
==== delete_agent ====
**Parámetro obligatorio:**
* < nombre_agente >
**Parámetro opcional:**
* ''use_alias''
* Tenga en cuenta que los alias de agente puede repetirse y puede borrar varios agentes en un solo paso.
**Descripción:**
Se eliminará el o los agente(s) pasando como parámetro su nombre o alias.
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf \
--delete_agent 'My Agent' \
use_alias
{{ :wiki:pfms-pandora_manage--delete_agent-use_alias.png }}
==== disable_group ====
**Parámetro obligatorio:**
* < nombre_de_grupo >
**Descripción:**
Desactiva todos los agentes de un grupo. Los [[:es:documentation:pandorafms:management_and_operation:11_managing_and_administration#grupos_en_pandora_fms|agentes del grupo]] pasado como parámetro serán desactivados con la ejecución de esta opción.
Si se pasa ''All'' como grupo se desactivarán todos los agentes de todos los grupos.
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --disable_group Firewalls
{{ :wiki:pfms-pandora_manage_--disable_group-example_1.png }}
==== enable_group ====
**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 [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --enable_group FIREWALLS
{{ :wiki:pfms-pandora_manage_--enable_group-example_1.png }}
==== create_group ====
**Parámetro obligatorio:**
* < nombre_del_grupo_nuevo >
**Parámetros opcionales:**
* < nombre_del_grupo_superior >
* < icono >
* ''applications''
* ''application_osx''
* ''application_osx_terminal''
* ''bricks''
* ''chart_organisation''
* ''clock''
* ''computer''
* ''database''
* ''database_gear''
* ''docker''
* ''drive_network''
* ''email''
* ''eye''
* ''firewall''
* ''heart''
* ''house''
* ''images''
* ''lightning''
* ''lock''
* ''network''
* ''plugin''
* ''printer''
* ''server_database''
* ''transmit''
* ''vmware''
* ''without_group''
* ''world''
* < descripción >
**Descripción:**
Un nuevo grupo será creado si el nombre no existe y, opcionalmente, se le puede asignar un grupo "padre" o superior, un icono para identificación gráfica (//el nombre del icono, sin extensión, utilice solamente las opciones listadas//) y una descripción. El grupo padre por defecto es '''All''' y el icono por defecto es una cadena de texto vacía (sin icono, no lo usará).
Si necesita agregar una descripción:
* Si no usara grupo padre coloque ''All'' como parámetro de relleno.
* Si no utilizase icono alguno coloque una cadena vacía (dos comillas simples juntas) como parámetro de relleno.
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --create_group \
'New group name' \
Web computer 'New description.'
==== delete_group ====
**Parámetro obligatorio:**
* < nombre_de_grupo >
**Descripción:**
Borra un grupo de agentes y sus agentes.
Cada agente que pertenezca al grupo indicado también será borrado.
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --delete_group 'Group name'
==== update_group ====
**Parámetro obligatorio:**
* < id_grupo >
**Parámetros opcionales:**
* < nombre_del_grupo_a_modificar >
* < nombre_del_grupo_superior >
* < icono >
* ''applications''
* ''application_osx''
* ''application_osx_terminal''
* ''bricks''
* ''chart_organisation''
* ''clock''
* ''computer''
* ''database''
* ''database_gear''
* ''docker''
* ''drive_network''
* ''email''
* ''eye''
* ''firewall''
* ''heart''
* ''house''
* ''images''
* ''lightning''
* ''lock''
* ''network''
* ''plugin''
* ''printer''
* ''server_database''
* ''transmit''
* ''vmware''
* ''without_group''
* ''world''
* < descripción >
**Descripción:**
Un grupo es modificado por medio de su identificador numérico. Los parámetros que pueden ser modificados son:
* Nombre del grupo.
* Nombre del grupo "padre" o superior.
* Icono (solo el nombre, sin extensión de fichero, escoja uno de la lista descrita).
* Descripción.
* Puede usar la función " [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#get_agent_group_id|get_agent_group_id]] " para obtener el identificador numérico de grupo de un agente cualquiera.
* En la Consola web puede ir al menú ►**Profiles**→ **Manage agent groups** y tomar nota del identificador numérico.
Debe tipear exactamente los mismos parámetros existentes si necesita cambiar solamente la descripción.
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --update_group 18 \
'Group name' 'Web' 'transmit' 'Description'
==== stop_downtime ====
**Parámetro obligatorio:**
* < nombre_de_parada_planificada >
**Descripción:**
Detiene una desconexión programada. Si la desconexión ya terminó se mostrará un mensaje. Mensajes de retorno:
* ''[ERROR] Planned_downtime < nombre_de_parada_planificada > cannot be stopped'' (la parada planificada no puede ser detenida).
* ''[INFO] Planned_downtime < nombre_de_parada_planificada > is already stopped'' (la parada planificada ya está detenida).
* ''[INFO] Stopping planned downtime < nombre_de_parada_planificada >'' (deteniendo parada planificada).
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --stop_downtime 'Downtine name'
==== get_agent_status ====
**Parámetro obligatorio:**
* < nombre_de_agente >
**Parámetro opcional:**
* ''use_agent_alias''
Para identificar al agente por medio de su alias en vez de su nombre, utilice ''use_alias'' justo al final.
**Descripción:** Obtener el estado de un agente determinado por medio de su nombre o alias.
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --get_agent_status 'agent name'
==== get_agent_group ====
**Parámetro obligatorio:**
* < nombre_de_agente >
**Parámetro opcional:**
* ''use_agent_alias''
Para identificar al agente por medio de su alias en vez de su nombre, utilice ''use_alias'' justo al final.
**Descripción:** Obtener el grupo de un agente determinado por medio de su nombre o alias.
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --get_agent_group 'agent name'
==== get_agent_group_id ====
**Parámetro obligatorio:**
* < nombre_de_agente >
**Parámetro opcional:**
* ''use_agent_alias''
Para identificar al agente por medio de su alias en vez de su nombre, utilice ''use_alias'' justo al final.
**Descripción:** Obtener el identificador de un agente determinado por medio de su nombre o alias.
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --get_agent_group_id 'agent name'
==== get_agent_modules ====
**Parámetro obligatorio:**
* < nombre_de_agente >
**Parámetro opcional:**
* ''use_agent_alias''
Para identificar al agente por medio de su alias en vez de su nombre, utilice ''use_alias'' justo al final.
**Descripción:** Obtener los módulos (identificadores y nombres, separados por una coma) de un agente determinado por medio de su nombre o alias.
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --get_agent_modules 'agent name'
==== get_agents ====
**Parámetro obligatorio:** Ninguno. Para obtener ayuda de dicho comando puede utilizar (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):
pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' '' '' '' '' '' ''
Obtendrá la siguiente respuesta indicando que excede la cantidad de parámetros:
[ERROR] Parameters error: 8 received | 0-7 necessary.
Pandora FMS CLI 7.0NG.764 Build 220930 Copyright (c) 2013-2023 Pandora FMS SL
This program is Free Software, licensed under the terms of GPL License v2
You can download latest versions and documentation at https://pandorafms.com/
[*] Pandora FMS Enterprise module loaded.
Available options for --get_agents:
--get_agents [] : Get
list of agents with optative filter parameters.
**Parámetros opcionales**: permiten filtrar la lista de agentes en un formato serializado donde importa el orden, utilice dos comillas simples para obviar parámetro(s). Se numeran aquí para mejor control y visualización:
- < [[:es:documentation:pandorafms:management_and_operation:11_managing_and_administration#creacion_de_un_grupo|nombre_de_grupo]] >
- < [[:es:documentation:pandorafms:management_and_operation:12_console_setup#operating_systems|nombre_de_sistema_operativo]] >
- < estado > Valores posibles: ''critical'', ''warning'', ''unknown'', ''normal''.
- < cantidad_máxima_de_módulos >
- < palabra_clave > Permite filtrar por nombre de agente (o alias de agente si agrega al final ''use_agent_alias'' ).
- < nombre_de_política >
- ''use_agent_alias''
**Descripción:** Obtener todos los agentes (sin parámetros) o los agentes de acuerdo a un filtro.
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
* Obtener todos los agentes en el grupo ''Network'':
pandora_manage /etc/pandora/pandora_server.conf --get_agents 'Network' '' '' '' '' ''
* Obtener todos los agentes que tengan ''Linux'' como sistema operativo:
pandora_manage /etc/pandora/pandora_server.conf --get_agents '' 'Linux' '' '' '' ''
* Obtener todos los agentes cuyo estado sea ''normal'':
pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' 'normal' '' '' ''
* Obtener todos los agentes con cero módulos (sin módulo alguno):
pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' '' '0' '' ''
* Obtener todos los agentes con cero módulos en el grupo ''Servers'':
pandora_manage /etc/pandora/pandora_server.conf --get_agents 'Servers' '' '' '0' '' ''
* Obtener todos los agentes que contengan la palabra ''test'' en su alias:
pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' '' '' 'test' '' use_agent_alias
==== get_agents_id_name_by_alias ====
**Parámetros:** [ ''strict'' ]
**Descripción:** Lista los identificadores y alias de los agentes que coinciden con el alias especificado. Usando el parámetro opcional ''strict'' limita la búsqueda a una coincidencia exacta.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agents_id_name_by_alias 'Estación'
==== Delete_conf_file ====
(>=5.0)
**Parámetros:**
**Descripción:** Se eliminará el fichero de configuración de un agente
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_conf_file 'Nombre de agente'
==== Clean_conf_file ====
(>=5.0)
**Parámetros:**
**Descripción:** Se limpiará el fichero de configuración de un agente o el de todos si no se pasan parámetros (Se eliminarán módulos, políticas, colecciones de ficheros y todos los comentarios).
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --clean_conf_file 'Nombre de agente'
==== get_bad_conf_files ====
**Parámetros:** Ninguno.
**Descripción:**
- Se listarán los ficheros de configuración mal configurados buscando en los //tokens// principales:
* ''server_ip''
* ''server_path''
* ''temporal''
* ''logfile''
- En caso de haber ficheros corruptos y que no puedan ser abiertos: ''[WARN] Can't open file < path_file >''.
- En caso de no encontrar el fichero en la ruta: ''[WARN] File not exist < path_file >''.
- En caso de que los archivos de configuración estén correctos (según los //tokens// del primer punto): ''[INFO] No bad files found''
**Ejemplos:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_bad_conf_files
Resultado del ejemplo:
{{ :wiki:pfms-open-perl_pandora_manage_pl-get_bad_conf_files.png }}
==== migration_agent_queue ====
(>=7.21) solo para la metaconsola
**Parámetros:** [id del agente a migrar] [nombre del nodo origen] [nombre del nodo destino] [parámetro opcional por defecto está a 0 migrará los datos tanto de histórico como de la propia db si está a 1 solo migrará los de la propia bd]
**Descripción:** Se añade un agente a la cola de migración para mover de nodo a otro nodo esto es solo para la metaconsola. Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en pandora_server.conf.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --migration_agent_queue 1 nodo1 nodo2 0
Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en ''pandora_server.conf'' ([[:es:documentation:pandorafms:installation:04_configuration#elementos_del_fichero_de_configuracion|elementos del fichero de configuración]]) : ''console_api_pass'' , ''console_pass'' , ''console_user'' y ''console_api_url'' .
==== migration_agent ====
(>=7.21) solo para la metaconsola
**Parametrizes:** [id del agente a comprobar]
**Descripción:** Devolverá true o false dependiendo si el agente introducido existe en la tabla de migración de agentes. Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en pandora_server.conf.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --migration_agent 1
Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en ''pandora_server.conf'' ([[:es:documentation:pandorafms:installation:04_configuration#elementos_del_fichero_de_configuracion|elementos del fichero de configuración]]) : ''console_api_pass'' , ''console_pass'' , ''console_user'' y ''console_api_url'' .
==== create_downtime ====
**Parámetros:**
**Descripción:** Se creará una parada planificada con los datos enviados.
* Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en ''pandora_server.conf''.
* El formato de fecha debe ser ''MM/DD/YYYY'' (Mes/Día/Año) para que esta llamada funcione adecuadamente.
**Example:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_downtime Testing Testing 05/07/2022 06/07/2022 0 1 1 1 1 1 1 1 17:07:00 18:08:00 1 31 quiet periodically weekly 7
Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en ''pandora_server.conf'' ([[:es:documentation:pandorafms:installation:04_configuration#elementos_del_fichero_de_configuracion|elementos del fichero de configuración]]) : ''console_api_pass'' , ''console_pass'' , ''console_user'' y ''console_api_url'' .
==== add_item_downtime ====
**Parámetros obligatorios:**
* < id_parada_planificada >
* < id_agente1,id_agente2,id_agente3,…,id_agenteN >
* < nombre_módulo1,nombre_módulo2,nombre_módulo3,…,nombre_móduloN >
**Descripción:**
Se añadirán registros a una parada planificada con los datos enviados. Escriba la lista de identificadores de agentes y la lista de nombres de módulo sin dejar espacios entre las comas que separan los componentes de ambas listas. Si el nombre de un módulo contiene espacios, coloque dicho nombre de módulo entre dos comillas simples. Si se pasan dos o más agentes, se asume de manera predeterminada que se quiere agregar módulos comunes, de no ser así mostrará un mensaje de advertencia.
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --add_item_downtime 1 1 Status,'Available Memory'
Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en ''pandora_server.conf'' ([[:es:documentation:pandorafms:installation:04_configuration#elementos_del_fichero_de_configuracion|elementos del fichero de configuración]]) : ''console_api_pass'' , ''console_pass'' , ''console_user'' y ''console_api_url'' .
==== get_all_planned_downtimes ====
**Parámetros obligatorios:**
* < nombre_a_buscar >
//**Parámetros opcionales:** //
* < id_grupo >
* < tipo_de_parada_planificada >
* ''quiet''
* ''disable_agents''
* ''disable_agents_alerts''
* < tipo_de_ejecución >
* ''once''
* ''periodically''
* < tipo_de_periodicidad >
* ''weekly''
* ''monthly''
**Descripción:**
Se listarán todos los registros que coincidan con los datos enviados. Consulte las opciones de [[:es:documentation:pandorafms:management_and_operation:11_managing_and_administration#paradas_de_servicio_planificadas|paradas de servicio planificadas]].
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
Para obtener toda la lista de paradas planificadas:
pandora_manage /etc/pandora/pandora_server.conf --get_all_planned_downtimes ''
==== get_planned_downtimes_items ====
**Parámetros obligatorios:**
* < nombre_a_buscar >
//**Parámetros opcionales:** //
* < id_grupo >
* < tipo_de_parada_planificada >
* ''quiet''
* ''disable_agents''
* ''disable_agents_alerts''
* < tipo_de_ejecución >
* ''once''
* ''periodically''
* < tipo_de_periodicidad >
* ''weekly''
* ''monthly''
**Descripción:**
Se listarán todos los items que coincidan con el nombre de la parada de servicio solicitada. Consulte las opciones de [[:es:documentation:pandorafms:management_and_operation:11_managing_and_administration#paradas_de_servicio_planificadas|paradas de servicio planificadas]].
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --get_planned_downtimes_items 'Name downtime'
==== set_planned_downtimes_deleted ====
**Parámetro obligatorio:**
* < id_parada_planificada >
**Descripción:**
Borra una parada planificada por medio de su identificador corresondiente. Algunos mensajes de retorno:
''This planned downtime is deleted'' "Esa parada planificada está borrada."
''Problems with this planned downtime'' "Problemas con esta parada planificada."
''The scheduled downtime is still being executed'' "Esta parada planificada aún está en ejecución."
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --set_planned_downtimes_deleted 7
==== set_disabled_and_standby ====
[[https://pandorafms.com/es/precios-de-pandora-fms/?o=dwpfms|{{:wiki:icono-modulo-enterprise.png?nolink&23x23 |Versión Enterprise}}]] Solamente para Metaconsola y Nodos.
\\
**Parámetros obligatorios:**
* < id_de_agente >
* //Para Metaconsola// el < id_metaconsola >, //para los nodos// coloque cualquier valor ya que es indiferente.
**Parámetros opcionales:**
* < valor > Por defecto ''1'' para habilitar el agente, ''0'' para deshabilitar.
**Descripción:** Deshabilita un agente y además, si tiene configuración remota, lo pone en modo //standby//.
Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en ''pandora_server.conf'' ([[:es:documentation:pandorafms:installation:04_configuration#elementos_del_fichero_de_configuracion|elementos del fichero de configuración]]) : ''console_api_pass'' , ''console_pass'' , ''console_user'' y ''console_api_url'' .
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
* Ejemplo para habilitar un agente desde el nodo:
perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 0 1
* Ejemplo para deshabilitar un agente desde nodo:
pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 0 0
* Ejemplo para habilitar un agente desde la metaconsola:
pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 1 1
* Ejemplo para deshabilitar un agente desde la metaconsola:
pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 1 0
Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en ''pandora_server.conf'' ([[:es:documentation:pandorafms:installation:04_configuration#elementos_del_fichero_de_configuracion|elementos del fichero de configuración]]) : ''console_api_pass'' , ''console_pass'' , ''console_user'' y ''console_api_url'' .
==== reset_agent_counts ====
**Parámetros:**
**Descripción:** Sincroniza los conteos de módulos y alertas de un agente dado. En caso de que se quiera sincronizar con todos los agentes el primer parámetro debe ser "All".
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --reset_agent_counts "All"
Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en ''pandora_server.conf'' ([[:es:documentation:pandorafms:installation:04_configuration#elementos_del_fichero_de_configuracion|elementos del fichero de configuración]]) : ''console_api_pass'' , ''console_pass'' , ''console_user'' y ''console_api_url'' .
==== insert_gis_data ====
**Parámetros obligatorios:**
* < id_del_agente >
* < latitud >
* < longitud >
* < altitud >
**Parámetros opcionales:**
* Ninguno.
**Descripción:** Actualiza los [[:es:documentation:pandorafms:monitoring:20_gis|datos GIS]] de un agente.
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --insert_gis_data 1 2 3 4
Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en ''pandora_server.conf'' ([[:es:documentation:pandorafms:installation:04_configuration#elementos_del_fichero_de_configuracion|elementos del fichero de configuración]]) : ''console_api_pass'' , ''console_pass'' , ''console_user'' y ''console_api_url'' .
==== get_gis_agent ====
**Parámetros obligatorios:**
* < id_del_agente >
**Parámetros opcionales:**
* Ninguno.
**Descripción:** Obtiene los [[:es:documentation:pandorafms:monitoring:20_gis|datos GIS]] de un agente.
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --get_gis_agent 1
Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en ''pandora_server.conf'' ([[:es:documentation:pandorafms:installation:04_configuration#elementos_del_fichero_de_configuracion|elementos del fichero de configuración]]) : ''console_api_pass'' , ''console_pass'' , ''console_user'' y ''console_api_url'' .
==== cli_agent_set_os ====
**Parámetros obligatorios:**
* < id_del_agente >
* < id_del_sistema_operativo >
* < versión_del_sistema_operativo >
**Parámetros opcionales:**
* Ninguno.
**Descripción:** Permite agregar o cambiar [[:es:documentation:pandorafms:management_and_operation:12_console_setup#operating_systems|el sistema operativo (y obsolescencia)]] a un agente.
**Ejemplo (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --cli_agent_set_os 7 3 'Ubuntu 16.04'
===== Módulos =====
==== create_data_module ====
**Parámetros obligatorios**:
* < nombre_de_módulo >
* < tipo_de_módulo >
* < nombre_de_agente >
**Parámetros opcionales**:
- < descripción >
- < grupo_módulo>
- < mínimo >
- < máximo >
- < post_proceso >
- < intervalo >
- < mínimo_de_advertencia >
- < máximo_de_advertencia >
- < mínimo_crítico >
- < máximo_crítico >
- < datos_histórico >
- < fichero_de_definición >
- < cadena_de_advertencia >
- < cadena_de_criticidad >
- < habilitar_eventos_desconocidos >
- < umbral_flip-flop >
- < cada_flip-flop >
- < umbral_flip-flop_normal >
- < umbral_flip-flop_advertencia >
- < umbral_flip-flop_crítico >
- < tiempo_de_espera_flip-flop >
- < inverso_de_advertencia >
- < inverso_de_criticidad >
- < instrucciones_de_criticidad >
- < instrucciones_de_advertencia >
- < instrucciones_de_estado_desconocido >
- ''use_agent_alias'': Para la búsqueda del agente utiliza el alias del agente en vez del nombre del agente.
- ''ignore_unknown'': Descarta el cálculo de estado desconocido, de manera que el módulo nunca cambiará a dicho estado y conservará siempre el último estado conocido.
**Descripción**: Se creará un módulo de tipo data en un agente con el nombre del módulo, tipo de módulo y nombre del agente (ver opción ''use_agent_alias'') donde se creará. Opcionalmente se le podrá otorgar una descripción, el grupo del módulo, etcétera.
Los valores por defecto son ''0'' para los mínimos y máximos, datos_histórico y post_proceso; ''300'' para el intervalo.
**Ejemplo (véase la [[#cli_de_pandora_fms|llamada]] y su [[#sintaxis|sintaxis]]):**
El fichero de definición del módulo contendrá algo de este estilo:
module_begin
module_name My module
module_type generic_data
module_exec cat /proc/meminfo | grep MemFree | awk '{ print $2 }'
module_end
pandora_manage /etc/pandora/pandora_server.conf --create_data_module 'My module' generic_data 'My agent' 'Module description' 'General' 1 3 0 300 0 0 0 0 1 /home/user/definition_file 'warning text' 'critical text'
Si se introduce un nombre o tipo diferente entre los parámetros y la definición del fichero, tendrá prioridad lo establecido en el fichero.
==== create_web_module ====
**Parámetros obligatorios**:
* < nombre_de_módulo >
* < tipo_de_módulo >
* < nombre_de_agente >
**Parámetros opcionales**:
- < descripción >
- < grupo_módulo>
- < mínimo >
- < máximo >
- < post_proceso >
- < intervalo >
- < mínimo_de_advertencia >
- < máximo_de_advertencia >
- < mínimo_crítico >
- < máximo_crítico >
- < datos_histórico >
- < reintentos >
- < consultas >
- < identificados_navegador_agente >
- < servidor_autenticación >
- < ámbito_de_autoridad >
- < fichero_de_definición >
- < url_de_proxy >
- < autorización_proxy_auth_login >
- < contraseña_autorización_proxy_auth_login >
- < cadena_de_advertencia >
- < cadena_de_criticidad >
- < habilitar_eventos_desconocidos >
- < umbral_flip-flop >
- < cada_flip-flop >
- < umbral_flip-flop_normal >
- < umbral_flip-flop_advertencia >
- < umbral_flip-flop_crítico >
- < tiempo_de_espera_flip-flop >
- < inverso_de_advertencia >
- < inverso_de_criticidad >
- < instrucciones_de_criticidad >
- < instrucciones_de_advertencia >
- < instrucciones_de_estado_desconocido >
- ''use_agent_alias'': Para la búsqueda del agente utiliza el alias del agente en vez del nombre del agente.
- ''ignore_unknown'': Descarta el cálculo de estado desconocido, de manera que el módulo nunca cambiará a dicho estado y conservará siempre el último estado conocido.
**Descripción**: Se creará un módulo de tipo web en un agente con el nombre del módulo, tipo de módulo y nombre del agente (ver parámetro ''use_agent_alias'') donde se creará. Opcionalmente se le podrá otorgar una descripción, el grupo del módulo, unos valores mínimo y máximo, un fichero de definición del módulo, entre otros parámetros.
**Ejemplo (véase la [[#cli_de_pandora_fms|llamada]] y su [[#sintaxis|sintaxis]]):**
El fichero de definición del módulo contendrá algo de este estilo:
task_begin
get http://pandorafms.com
task_end
Ejemplo:
pandora_manage /etc/pandora/pandora_server.conf --create_web_module 'module_name' web_data 'pandorafms' 'Module description' 'General' 0 100 0 300 0 0 0 0 1 0 1 'Pandora FMS' auto public /home/user/file_definition 'http://proxy.url' 'proxy_login' 'proxy_password' 1 10 10 10 10 10 10 10 10 1 1 'critical_instructions' 'warning_instructions' 'unknown_instructions'
==== create_network_module ====
**Parámetros obligatorios**:
* < nombre_modulo >
* < tipo_modulo >
* < nombre_agente >
* < dirección_modulo >
**Parámetros opcionales**:
* < puerto_modulo > valor numérico entre ''1'' y ''65535''.
* < descripción >
* < grupo_modulo >
* < min >
* < max >
* < post_process >
* < intervalo >
* < warning_min >
* < warning_max >
* < critical_min >
* < critical_max >
* < history_data >
* < ff_threshold >
* < warning_str >
* < critical_str >
* < enable_unknown_events >
* < each_ff >
* < ff_threshold_normal >
* < ff_treshold_warning >
* < ff_threshold_critical >
* < critical_instructions >
* < warning_instructions >
* < unknown_instructions >
* ''use_agent_alias'' para buscar el agente por su alias en vez de su nombre.
* ''ignore_unknown'' Descarta el cálculo de estado desconocido, de manera que el módulo nunca cambiará a dicho estado y conservará siempre el último estado conocido.
**Descripción**: Se creará un módulo de red en un agente con el nombre del módulo, tipo de módulo, nombre del agente donde se creará y la dirección del módulo especificados. Opcionalmente se le podrá otorgar un número de puerto, una descripción, unos valores mínimos y máximos, un valor '
de post procesado, un intervalo en segundos, unos valores de advertencia mínimos y máximos, unos valores de criticidad mínimos y máximos, y un valor de datos históricos.
Los valores por defecto son ''0'' para los mínimos y máximos, ''history_data'' y ''post_process'' y ''300'' segundos para el intervalo.
El número de puerto es opcional, ya que los módulos de tipo ICMP no precisan de él. En el resto de los tipos es necesario especificar un módulo.
**Ejemplo (véase la [[#cli_de_pandora_fms|llamada]] y su [[#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --create_network_module 'My module' remote_tcp 'My agent' 192.168.12.123 8080 'Module description' 'General' 1 3 0 300 0 0 0 0 1
==== Create_network_component ====
**Parámetros:** []
**Descripción:** Se creará un componente de red. Opcionalmente se le podrá otorgar un puerto, una descripción, unos valores min y max, un valor post_process, un intervalo en segundos, unos valores warning min y max, unos valores critical min y max, y un valor history data.
Los valores por defecto son 0 para los mínimos y máximos, history_data y post_process y 300 para el intervalo.
El puerto es optativo ya que los módulos de tipo ICMP no precisan de él. En el resto de tipos si que es necesario especificar un módulo.
**Notas:**
Los siguientes parámetros son solo a partir de la versión 5 de Pandora:
*
Los siguientes parámetros son solo a partir de la versión 5.1 de Pandora:
*
*
*
*
**Ejemplo:**
perl /tmp/pandorafms/pandora_server/util/pandora_manage.pl /etc/pandora/pandora_server.conf --create_network_component "example_name" 2 7
Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en ''pandora_server.conf'' ([[:es:documentation:pandorafms:installation:04_configuration#elementos_del_fichero_de_configuracion|elementos del fichero de configuración]]) : ''console_api_pass'' , ''console_pass'' , ''console_user'' y ''console_api_url'' .
==== create_snmp_module ====
**Parámetros obligatorios**:
* < module_name >
* < module_type >
* < agent_name >
* < module_address >
* < module_port >
* < version >
**Parámetros opcionales**:
* < community >
* < oid >
* < description >
* < module_group >
* < min >
* < max >
* < post_process >
* < interval >
* < warning_min >
* < warning_max >
* < critical_min >
* < critical_max >
* < history_data >
* < snmp3_priv_method >
* < snmp3_priv_pass >
* < snmp3_sec_level >
* < snmp3_auth_method >
* < snmp3_auth_user >
* < snmp3_auth_pass >
* < ff_threshold>
* < warning_str >
* < critical_str >
* < unknown_events >
* < each_ff >
* < ff_threshold_normal >
* < ff_threshold_warning >
* < ff_threshold_critical >
* < timeout >
* < retries >
* ''use_alias'' para buscar el agente por su alias en vez de su nombre.
* ''ignore_unknown'' Descarta el cálculo de estado desconocido, de manera que el módulo nunca cambiará a dicho estado y conservará siempre el último estado conocido.
**Descripción**: Se creará un módulo de tipo SNMP en un agente con el nombre del módulo, tipo de módulo, nombre del agente donde se creará, la dirección del módulo, el puerto asociado y la versión de SNMP especificados. Opcionalmente se le podrá suministrar un nombre de comunidad, un OID, una descripción, el grupo del módulo, unos valores mínimos y máximos, un valor de post procesado, un intervalo en segundos, unos valores de advertencia mínimos y máximos, unos valores de criticidad mínimos y máximos, y los parámetros de SNMP 3 tales como métodos, contraseñas, etcétera.
Los valores por defecto son ''0'' para los mínimos y máximos, ''history_data'' y ''post_process'' y 300 segundos para el intervalo.
**Ejemplo (véase la [[#cli_de_pandora_fms|llamada]] y su [[#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --create_snmp_module 'My module' remote_snmp_inc 'My agent' 192.168.12.123 8080 1 my_comunnity my_oid 'Module description'
==== create_plugin_module ====
**Parámetros obligatorios**:
* < nombre_modulo >
* < tipo_modulo >
* < nombre_agente >
* < direccion_modulo >
* < puerto_modulo > valor numérico entre ''1'' y ''65535''.
* < nombre_plugin >
* < usuario >
* < password >
* < parametros >
**Parámetros opcionales**:
* < descripción >
* < grupo_modulo >
* < min >
* < max >
* < post_process >
* < intervalo >
* < warning_min >
* < warning_max >
* < critical_min >
* < critical_max >
* < history_data >
* < ff_threshold >
* < warning_str >
* < critical_str >
* < enable_unknown_events >
* < each_ff >
* < ff_threshold_normal >
* < ff_treshold_warning >
* < ff_threshold_critical >
* < critical_instructions >
* < warning_instructions >
* < unknown_instructions >
* ''use_agent_alias'' para buscar el agente por su alias en vez de su nombre.
* ''ignore_unknown'' Descarta el cálculo de estado desconocido, de manera que el módulo nunca cambiará a dicho estado y conservará siempre el último estado conocido.
**Descripción**: Se creará un módulo de tipo //plugin// en un agente con el nombre del módulo, tipo de módulo, nombre del agente donde se creará, la dirección del módulo, el puerto asociado y nombre de plugin correspondiente. Opcionalmente se le podrá suministrar una descripción, el grupo del módulo, unos valores mínimos y máximos, un valor de post procesado, un intervalo en segundos, unos valores de advertencia mínimos y máximos, unos valores de criticidad mínimos y máximos, entre otros valores opcionales.
Los valores por defecto son ''0'' para los mínimos y máximos, ''history_data'' y ''post_process'' y ''300'' para el intervalo.
**Ejemplo (véase la [[#cli_de_pandora_fms|llamada]] y su [[#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --create_plugin_module 'My module' generic_data 'Mi agente' 192.168.12.123 8080 myplugin myuser mypass 'param1 param2 param3' 'Descripcion del modulo' 'General' 1 3 0 300 0 0 0 0 1
==== Get_module_group ====
**Parámetros:** []
**Descripción:** Muestra los grupos de módulos disponibles. Podemos filtrar añadiendo el nombre del grupo o parte de este.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_group "grupo de módulos"
==== Create_module_group ====
**Parámetros:**
**Descripción:** Se creará un grupo de módulos con el nombre especificado.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_module_group 'Nombre del grupo'
==== Module_group_synch ====
**Parámetros:** []
**Descripción:** Se sincronizarán los grupos de módulos de la meta con los nodos que hayan sido especificados en el primer parámetro, separados con "|". De manera opcional se podrá indicar en el segundo parámetro el formato en que se devolverán los datos (csv o json). Por defecto vendrán en formato csv.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --module_group_synch "server_name1|server_name2|server_name3" "json"
Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en ''pandora_server.conf'' ([[:es:documentation:pandorafms:installation:04_configuration#elementos_del_fichero_de_configuracion|elementos del fichero de configuración]]) : ''console_api_pass'' , ''console_pass'' , ''console_user'' y ''console_api_url'' .
==== Create_synthetic ====
**Parámetros:**
Donde puede ser "arithmetic" o "average".
**Ejemplos**
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic modulo_ejemplo arithmetic agente_ejemplo
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic modulo_ejemplo average agente_ejemplo
Explicamos los posibles parámetros que pueden utilizarse en la parte >
* = ,,,,
* = ,,,
**Ejemplos**
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic modulo_ejemplo arithmetic agente_ejemplo mi_agente, ,mi_modulo mi_agente2,-,mi_modulo2
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic modulo_ejemplo arithmetic agente_ejemplo mi_agente, ,mi_modulo *,10
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic modulo_ejemplo average agente_ejemplo mi_agente,x,mi_modulo mi_agente,x,mi_modulo2
En el primer ejemplo, se creará en el agente //agente_ejemplo// un módulo con nombre //modulo_ejemplo// de tipo aritmético, su contenido será el resultado de la resta de //mi_modulo// - //mi_modulo2// En el segundo ejemplo, se creará en el agente //agente_ejemplo// un módulo con nombre //modulo_ejemplo// de tipo aritmético, su contenido será el resultado de la multiplicación de //mi_modulo// * 10.
El primer operando que se utiliza, en el caso anterior entre mi_agente y mi_modulo ( ), no se tiene en cuenta para las operaciones, pero por funcionamiento de la herramienta es necesario introducirlo, es importante tener en cuenta que la operación aritmética se hará teniendo en cuenta el siguiente operando, en este caso entre //mi_agente2// y //mi_modulo2//, o justo antes del valor 10 (en este caso, los operadores "-" o "*"). Los posibles operandos son:
* suma
* **-** resta
* * multiplicación
* **/** división
* **x** media. Este operando solo podrá utilizarse con el tipo de módulo //average//.
**Descripción:** Se creará un módulo sintético en el agente y con el nombre de módulo indicados, El tipo de módulo puede ser arithmetic (aritmética) o average (promedio). Los operandos pueden ser: , -, *, / o x.
**Notas:**
Disponible a partir de Pandora 5.1 SP4
**Ejemplos:**
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic suma_memoria arithmetic nodo51sp3 production1, ,AvailableMemory production2, ,AvailableMemory
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic diferencia_trafico arithmetic nodo51sp3 nodo51sp3, ,InputTraffic nodo51sp3,-,OutputTraffic
==== delete_module ====
**Parámetros obligatorios:**
* < nombre_de_módulo >
* < nombre_de_agente >
**Parámetros opcionales:**
* ''use_alias''
**Descripción:** Se eliminará un módulo de un agente pasados el nombre de ambos como parámetro. En el caso de que este módulo esté en un agente local, también será eliminado del fichero de configuración si se dispone de la versión Enterprise. A partir de la versión 771 se eliminan recursivamente los //descendientes// del módulo borrado.
**Ejemplos (véase la [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#cli_de_pandora_fms|llamada]] y su [[:es:documentation:pandorafms:technical_reference:03_anexo_cli#sintaxis|sintaxis]]):**
pandora_manage /etc/pandora/pandora_server.conf --delete_module 'My module' 'My agent'
==== Data_module ====
**Parámetros:** []
**Descripción:** Se mandarán datos a un módulo de un agente pasándole como parámetro el nombre del servidor, del agente, del módulo, el tipo de módulo y el dato a introducir. De forma optativa se podrá enviar la fecha-hora que figurará como de envío de los datos con formato 24 horas: 'YYY-MM-DD HH:mm'. En el caso de no enviar este parámetro figurará la fecha actual.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --data_module Servidor-General 'Mi agente' 'My module' 'generic_data' 1 '2010-05-31 15:53'
==== Get_module_data ====
(>=5.0)
**Parametros:** []
**Descripción:** Se devolverán los datos de un módulo como 'timestamp dato' en formato CSV de los últimos X segundos (intervalo) usando como separador por defecto ';'
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_data 'nombre agente' 'nombre modulo' 86400 ':'
==== Get_module_id ====
**Parametros:**
**Descripción:** Se devolverá la id de un módulo concreto de un agente.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_id 4 'host alive'
==== Get_module_custom_id ====
**Parametros:**
**Descripción:** Se devolverá el valor del campo //Custom ID// de un módulo concreto de un agente.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_module_custom_id 4
==== Set_module_custom_id ====
**Parametros:** []
**Descripción:** Se insertará el valor del campo //Custom ID// de un módulo concreto de un agente. Si se deja en blanco eliminará el contenido que hubiese anteriormente dejando el campo vacío.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_module_custom_id 4 '21'
==== Delete_data ====
**Parámetros:** | -a | -g
**Descripción:** Se eliminarán del histórico de datos todos los datos asociados a un módulo en el caso de pasar como parámetro la opción -m y el nombre de éste junto al de su agente; de los módulos de un agente, si como parámetro se pasa la opción '-a' y el nombre de un agente o de los módulos de todos los agentes de un grupo, si como parámetro se pasa la opción '-g' y el nombre de un grupo.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_data -a 'Mi agente'
En este ejemplo se eliminarían los datos históricos de todos los módulos pertenecientes al agente 'Mi agente'.
==== Update_module ====
**Parámetros:**
**Descripción:** Se actualizará un campo dado de un módulo existente. Se detectará el tipo de módulo para permitir actualizar los campos específicos de cada tipo.
Los campos posibles son:
* **Comunes a cualquier módulo**: module_name, agent_name, description, module_group, min, max, post_process, history_data, interval, warning_min, warning_max, critical_min, critical_max, warning_str, critical_str, ff_threshold, each_ff, ff_threshold_normal, ff_threshold_warning, ff_threshold_critical, critical_instructions, warning_instructions, unknown_instructions, critical_instructions, warning_instructions, unknown_instructions
* **Para los módulos de datos**: ff_timeout
* **Para los módulos de red**: module_address, module_port
* **Para los módulos de tipo SNMP**: module_address, module_port, version, community, oid, snmp3_priv_method, snmp3_priv_pass, snmp3_sec_level, snmp3_auth_method, snmp3_auth_user, snmp3_priv_pass
* **Para los módulos de tipo plugin**: module_address, module_port, plugin_name, user, password, parameters
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_module 'Nombre del módulo' 'Nombre del agente' description 'Nueva descripción'
==== add_tag_to_module ====
**Parametros:**
**Descripción:** Adiciona una etiqueta (//tag//) al módulo especificado.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_tag_to_module 'Nombre de agente' 'Nombre de módulo' 'Nombre de etiqueta'
Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en ''pandora_server.conf'' ([[:es:documentation:pandorafms:installation:04_configuration#elementos_del_fichero_de_configuracion|elementos del fichero de configuración]]) : ''console_api_pass'' , ''console_pass'' , ''console_user'' y ''console_api_url'' .
==== Get_agents_module_current_data ====
(>=5.0)
**Parámetros:**
**Descripción:** Obtener el agente y el dato actual de todos los módulos con un nombre dado
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agents_module_current_data 'Nombre módulo'
==== Create_network_module_from_component ====
(>=5.0)
**Parámetros:**
**Descripción:** Crear un nuevo módulo de red en el agente especificado desde el componente de red.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_network_module_from_component 'Nombre agente'
==== Create_data_module_from_local_component ====
(>=5.1)
**Parámetros:**
**Descripción:** Crear un nuevo módulo de datos en el agente especificado desde el componente local.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_data_module_from_local_component 'Nombre agente' 'Mi componente local'
==== Create_local_component ====
(>=5.1)
**Parámetros:** []
**Descripción:** Crear un nuevo componente local.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_local_component 'Nuevo componente local' 'module_begin\nmodule_name name\nmodule_type generic_data\nmodule_exec exec\nmodule_end'
==== Apply_module_template ====
**Parámetros:** []
**Descripción:** Estas plantillas de módulos son una agrupación que contiene módulos de comprobación de red. Estas plantillas pueden ser aplicadas directamente a agentes, evitando tener que añadir módulos uno a uno.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --apply_module_template 1 1
===== Alertas =====
==== Create_template_module ====
**Parámetros:**
**Descripción:** Se asignará una plantilla a un módulo de un agente pasándole el nombre de la plantilla, el módulo y el agente como parámetro.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_template_module plantilla001 'My module' 'Mi agente'
==== Delete_template_module ====
**Parámetros:**
**Descripción:** Se desasignará una plantilla de un módulo de un agente pasándole el nombre de la plantilla, el módulo y el agente como parámetro.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_template_module plantilla001 'My module' 'Mi agente'
==== Create_template_action ====
**Parámetros:** []
**Descripción:** Se añadirá una acción a una alerta pasando como parámetros el nombre de la acción y el de la plantilla, módulo y agente que conforman la alerta. También se le podrán pasar de forma optativa los valores de escalado fires_min y fires_max (por defecto 0).
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_template_action acción012 plantilla001 'My module' 'Mi agente' 0 4
==== Delete_template_action ====
**Parámetros:**
**Descripción:** Se añadirá una acción a una alerta pasando como parámetros el nombre de la acción y el de la plantilla, módulo y agente que conforman la alerta.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_template_action acción012 plantilla001 'My module' 'Mi agente'
==== Disable_alerts ====
**Parámetros:** No
**Descripción:** Todas las alertas serán desactivadas con la ejecución de esta opción. Si cuando se ejecuta tuvieramos alguna alerta desactivada y volvemos a activar todas, esta también será activada.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_alerts
==== Enable_alerts ====
**Parámetros:** No
**Descripción:** Todas las alertas serán activadas con la ejecución de esta opción. Si cuando se ejecuta tuvieramos alguna alerta activada y volvemos a desactivar todas, esta también será desactivada.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_alerts
==== Create_alert_template ====
**Parámetros:** []
**Descripción:** Se creará una plantilla de alerta.
**El campo **: Son las opciones de tipo de plantilla serializadas con el separador ';' por defecto. Se puede cambiar el separador con el parámetro para evitar conflictos en algunas opciones is existiera la posibilidad de que contuviesen el caracter por defecto.
Las posibilidades son las siguientes:
//NOTA: En estos ejemplos es usado el separador por defecto ';' y el campo matches_value es un valor binario para establecer si la alerta se disparará cuando el valor coincida o no con las condiciones.//
* **Expresión regular**:
* **Sintaxis**: ;;
* **Ejemplo**: regex;1;stopped|error (Alerta cuando el valor coincida con la expresión regular 'stopped|error')
* **Máx. y mín.**:
* **Sintaxis**: ;;;
* **Ejemplo**: max_min;0;30;50 (Alerta cuando el valor está fuera del intervalo 30-50)
* **Máx.**:
* **Sintaxis**: ;
* **Ejemplo**: max;70 (Alerta cuando el valor es mayor de 70)
* **Mín.**:
* **Sintaxis**: ; :
* **Ejemplo**: min;30 (Alerta cuando el valor es menor de 30)
* **Igual a**:
* **Sintaxis**: ;
* **Ejemplo**: equal;0 (Alerta cuando el valor es igual a 0)
* **Diferente de**:
* **Sintaxis**: ;
* **Ejemplo**: not_equal;100 (Alerta cuando el valor es distinto de 100)
* **Estado advertencia**:
* **Sintaxis**:
* **Ejemplo**: warning (Alerta cuando el estado cambie a advertencia)
* **Estado crítico**:
* **Sintaxis**:
* **Ejemplo**: critical (Alerta cuando el estado cambie a crítico)
* **Estado desconocido**:
* **Sintaxis**:
* **Ejemplo**: unknown (Alerta cuando el estado cambie a desconocido)
* **Estado distinto a normal**:
* **Sintaxis**:
* **Ejemplo**: not_normal (Alerta cuando el estado sea distinto a normal -warning, critical, etc.-)
* **En estado de cambio**:
* **Sintaxis**: ;
* **Ejemplo**: onchange;1 (Alerta cuando el valor cambie)
* **Siempre**:
* **Sintaxis**:
* **Ejemplo**: always (Alerta siempre)
**El campo **: Son siete caracteres binarios que especifican los días de la semana cuando la alerta estará activada. p.e.: 0000011 para activar la alerta solo sábado y domingo.
**Example:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf.2011-10-25 --create_alert_template 'nombre de la plantilla' "max_min@1@3@5" 09:00 18:00 "Manda un email cuando el valor está en el intervalo 3-5, entra las 9AM y las 6PM, y solo los Lunes. El separador es forzado a @" "Unknown" "mail@mail.com" "asunto" "mensaje" 3 "Mail to XXX" 1000000 38600 1 2 0 @
==== Delete_alert_template ====
(>=5.0)
**Parámetros:**
**Descripción:** Se eliminará una plantilla de alerta si existe.
**Example:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_alert_template 'Nombre de plantilla'
==== Update_alert_template ====
(>=5.0)
**Parámetros:**
**Descripción:** Se actualizará un campo dado de una plantilla de alerta existente. Los campos posibles son los siguientes: name, description, type, matches_value, value, min_value, max_value, time_threshold(0-1), time_from, time_to, monday(0-1), tuesday(0-1), wednesday(0-1), thursday(0-1), friday(0-1), saturday(0-1), sunday(0-1), min_alerts, max_alerts, recovery_notify(0-1), field1, field2, field3, recovery_field2, recovery_field3, priority(0-4), default_action, group_name.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_alert_template 'Nombre de plantilla' priority 4
==== Get_alert_actions ====
(>=5.0)
**Parámetros:** []
**Descripción:** Devuelve todas las acciones de las alertas. Opcionalmente se puede filtrar el resultado por el nombre. De manera opcional en el segundo parámetro se puede especificar el separador de los resultados y en el tercer parámetro el formato de la lista devuelta (csv, json, string).
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_alert_actions 'Action 1' ';' 'json'
Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en ''pandora_server.conf'' ([[:es:documentation:pandorafms:installation:04_configuration#elementos_del_fichero_de_configuracion|elementos del fichero de configuración]]) : ''console_api_pass'' , ''console_pass'' , ''console_user'' y ''console_api_url'' .
==== Get_alert_actions_meta ====
(>=5.0)
Esta característica está en Metaconsola.
**Parámetros:** []
**Descripción:** Devuelve todas las acciones de alerta de la metaconsola. Opcionalmente se puede filtrar el resultado por el nombre del nodo o por nombre de la acción. De manera opcional en el segundo parámetro se puede especificar el separador de los resultados y en el tercer parámetro el formato de la lista devuelta (csv, json, string).
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_alert_actions_meta 'Action 1' ';' 'json'
Para que se realice correctamente se necesitará que estén rellenos los parámetros de configuración de la API en ''pandora_server.conf'' ([[:es:documentation:pandorafms:installation:04_configuration#elementos_del_fichero_de_configuracion|elementos del fichero de configuración]]) : ''console_api_pass'' , ''console_pass'' , ''console_user'' y ''console_api_url'' .
==== Create_alert_command ====
(>=5.0)
**Parámetros:** []
**Descripción:** Se creará un comando con los datos de nombre y comando especificados. Opcionalmente se podrá especificar:
* Nombre del grupo. Si no se proporciona grupo se asignará en el grupo 'All'.
* Descripción del comando.
* Internal (1-0).
* Descripción de campos. Este se pasará en el siguiente formato: '["descr1","descr2","descr3","descr4","descr5"]'.
* Valor de los campos: Este se pasará en el siguiente formato: ["val1","val2","val3","val4","val5"].
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_alert_command 'PRUEBA' 'command' 'All' 'Desc' '1' '["des1","des2","des3","","des5","","","","",""]' '["val1","val2","val3","val4","","","","","",""]'
==== Get_alert_commands ====
(>=5.0)
**Parámetros:** []
**Descripción:** Permite ver todas las alertas. Opcionalmente se puede filtrar el resultado por: nombre, comando, grupo, descripción o si es interno (1-0). En el caso del nombre, comando y descripción no hace falta introducir el dato exacto.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_alert_commands "command_name"
==== validate_alert ====
**Parámetros:** [ ''use_alias'' ]
**Descripción:** Valida una alerta dados un nombre de plantilla, un ID de agente y un ID de módulo. En lugar de utilizar sólo un ID de agente, puede utilizar el nombre del agente con el último parámetro ''use_alias'' (quizás para validar múltiples alertas).
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_alert 7 10 15
==== Validate_all_alerts ====
(>=5.0)
**Parámetros:** None
**Descripción:** Se validan todas las alertas.
**Ejemplo:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_all_alerts
==== Create_special_day ====
(>=5.1)
**Parámetros:**
**Descripción:** Crear un día especial. Los posibles same_day son: lunes, martes, miércoles, jueves, viernes, sábado y domingo.
**Example:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_special_day 2014-05-03 domingo Desc All
==== Delete_special_day ====
(>=5.1)
**Parámetros:**
**Descripción:** Borrado del día especial especificado.
**Example:**
perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_special_day 2014-05-03
==== Update_special_day ====
(>=5.1)
**Parámetros:**
**Descripción:** Modificar un campo específico de un día especial. Los campos que se puede actualizar son: same_day, description y group_name. Los posibles valores para same_day son: lunes, martes, miércoles, jueves, viernes, sábado y domingo.
**Example:**