====== Interfaz de Línea de Comandos (CLI) ======

{{indexmenu_n>3}}

<wrap #ks1 />
===== 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 ''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.

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

</code>

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

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


</code>

<wrap #ks1_1 />
==== Sintaxis ====

  * 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, [[#ks2_1|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.

<wrap #ks1_2 />
==== Ayuda ====

Ayuda general:

<code bash>
pandora_manage --h

</code>

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

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --create_user

</code>

<wrap #ks2 />
===== Agentes =====

<wrap #ks2_1 />
==== create_agent ====

**Parámetros obligatorios ([[#ks1_1|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.

<WRAP center round info 90%>

Si va a utilizar un nombre de agente aleatorio utilizando ''0'' como último parámetro, se debe especificar de forma obligatoria el periodo del agente, siendo el valor recomendado de 300 segundos.

</WRAP>

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

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

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

</code>

<wrap #ks2_2 />
==== update_agent ====

**Parámetros obligatorios ([[#ks1_1|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''
  * ''update_gis_data'' ( ''0''  para inactivarlo, ''1'' para activarlo).
  * ''custom_id''

<WRAP center round tip 60%>

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

</WRAP>

**Ejemplos (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --update_agent \
    'My Agent' agent_name 'Agent 2'

</code>

Al cambiar la [[es:documentation:pandorafms:monitoring:01_intro_monitoring#ks2_2|dirección IP de un agente]] téngase en cuenta que este comando permite repetir direcciones IP.

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --update_agent \
    'My Agent' address 192.168.7.47

</code>

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

</code>

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.

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

</code>

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.

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

</code>

<wrap #ks2_3 />
==== agent_update_custom_fields ====

**Parámetros obligatorios ([[#ks1_1|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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

TIPO TEXTO:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf \
 --agent_update_custom_fields \
 1 0 'Serial number' 'THX-1138'

</code>

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

<code bash>
pandora_manage /etc/pandora/pandora_server.conf \
 --agent_update_custom_fields \
 1 1 'Names' 'John'

</code>

<wrap #ks2_4 />
==== delete_agent ====

**Parámetros obligatorios ([[#ks1_1|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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf \
    --delete_agent 'pandora.internals' \
    use_alias

</code>

<wrap #ks2_5 />
==== 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.

<WRAP center round important 60%>Si se pasa ''All''  como grupo se desactivarán todos los agentes de todos los grupos.</WRAP>

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --disable_group Firewalls


</code>

{{  :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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --enable_group FIREWALLS


</code>

{{  :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á).

<WRAP center round info 60%>

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.

</WRAP>

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

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


</code>


==== delete_group ====

**Parámetro obligatorio**:

   * < nombre_de_grupo >

**Descripción**:

Borra un grupo de agentes y sus agentes.

<WRAP center round important 60%>

Cada agente que pertenezca al grupo indicado también será borrado.

</WRAP>

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --delete_group 'Group name'

</code>


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

<WRAP center round tip 60%>

  * Puede usar la función " [[#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.

</WRAP>

<WRAP center round important 60%>

Debe tipear exactamente los mismos parámetros existentes si necesita cambiar solamente la descripción.

</WRAP>

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

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


</code>


==== 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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --stop_downtime 'Downtine name'


</code>


==== get_agent_status ====

**Parámetro obligatorio**:

   * < nombre_de_agente >

**Parámetro opcional**:

  * ''use_agent_alias''<WRAP center round tip 60%>
Para identificar al agente por medio de su alias en vez de su nombre, utilice ''use_alias''  justo al final.

</WRAP>

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

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agent_status 'agent name'


</code>


==== get_agent_group ====

**Parámetro obligatorio**:

   * < nombre_de_agente >

**Parámetro opcional**:

  * ''use_agent_alias''<WRAP center round tip 60%>
Para identificar al agente por medio de su alias en vez de su nombre, utilice ''use_alias''  justo al final.

</WRAP>

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

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agent_group 'agent name'


</code>


==== get_agent_group_id ====

**Parámetro obligatorio**:

   * < nombre_de_agente >

**Parámetro opcional**:

  * ''use_agent_alias''<WRAP center round tip 60%>
Para identificar al agente por medio de su alias en vez de su nombre, utilice ''use_alias''  justo al final.

</WRAP>

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

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agent_group_id 'agent name'


</code>


==== get_agent_modules ====

**Parámetro obligatorio**:

   * < nombre_de_agente >

**Parámetro opcional**:

  * ''use_agent_alias''<WRAP center round tip 60%>
Para identificar al agente por medio de su alias en vez de su nombre, utilice ''use_alias''  justo al final.

</WRAP>

**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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agent_modules 'agent name'


</code>


==== get_agents ====

**Parámetro obligatorio**: Ninguno. Para obtener ayuda de dicho comando puede utilizar (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]]):

<code bash>
 pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' '' '' '' '' '' ''


</code>

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

<code bash>
[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 module loaded.

Available options for --get_agents:

        --get_agents [<group_name> <os_name> <status> <max_modules> <filter_substring> <policy_name> <use_alias>] : Get
          list of agents with optative filter parameters.


</code>

**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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:
  * Obtener todos los agentes en el grupo ''Network'':

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agents 'Network' '' '' '' '' ''


</code>

  * Obtener todos los agentes que tengan ''Linux''  como sistema operativo:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agents '' 'Linux' '' '' '' ''


</code>

  * Obtener todos los agentes cuyo estado sea ''normal'':

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' 'normal' '' '' ''


</code>

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

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' '' '0' '' ''


</code>

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

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agents 'Servers' '' '' '0' '' ''


</code>

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

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_agents '' '' '' '' 'test' '' use_agent_alias


</code>


==== get_agents_id_name_by_alias ====

**Parámetros**: <alias_de_agente> [ ''strict'' ]

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_agents_id_name_by_alias 'Estación'

</code>


==== Delete_conf_file ====

(>=5.0)

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

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

**Ejemplo**:

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

</code>

==== Clean_conf_file ====

(>=5.0)

**Parámetros**: <use_agent_alias>

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --clean_conf_file 'Nombre de agente'

</code>


==== 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**:

<code bash>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_bad_conf_files

</code>

Resultado del ejemplo:

{{  :wiki:pfms-open-perl_pandora_manage_pl-get_bad_conf_files.png  }}


==== migration_agent_queue ====

(>=7.21) solo para el Command Center (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 el Command Center (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**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --migration_agent_queue 1 nodo1 nodo2 0

</code>

<WRAP center round important 75%>

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

</WRAP>


==== migration_agent ====

(>=7.21) solo para el Command Center (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**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --migration_agent 1

</code>

<WRAP center round important 75%>

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

</WRAP>


==== create_downtime ====

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

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

<WRAP center round important 75>

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

</WRAP>

**Example**:
<code>

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

</code>

<WRAP center round important 75%>

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

</WRAP>


==== 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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --add_item_downtime 1 1 Status,'Available Memory'


</code>

<WRAP center round important 75%>

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

</WRAP>


==== 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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

Para obtener toda la lista de paradas planificadas:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_all_planned_downtimes ''


</code>


==== 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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_planned_downtimes_items 'Name downtime'


</code>


==== 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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --set_planned_downtimes_deleted 7

</code>


==== set_disabled_and_standby ====

<WRAP center round info 60%>

Solamente para el Command Center (Metaconsola) y Nodos.

</WRAP>\\
**Parámetros obligatorios**:

   * < id_de_agente >
  * //Para el Command Center (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//.

<WRAP center round important 75%>

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

</WRAP>

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:
  * Ejemplo para habilitar un agente desde el nodo:

<code bash>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 0 1


</code>

  * Ejemplo para deshabilitar un agente desde nodo:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 0 0


</code>

  * Ejemplo para habilitar un agente desde el Command Center (Metaconsola):

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 1 1


</code>

  * Ejemplo para deshabilitar un agente desde el Command Center (Metaconsola):

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --set_disabled_and_standby 2 1 0


</code>

<WRAP center round important 75%>

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

</WRAP>


==== reset_agent_counts ====

**Parámetros**: <id_agent>

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --reset_agent_counts "All"

</code>

<WRAP center round important 75%>

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

</WRAP>


==== insert_gis_data ====

**Parámetros obligatorios**:

   * < id_del_agente >
  * < latitud >
  * < longitud >
  * < altitud >

**Parámetros opcionales**:

  * <font inherit/inherit;;inherit;;rgb(251, 250, 249)>Ninguno.</font>

**Descripción**:  Actualiza los [[:es:documentation:pandorafms:monitoring:20_gis|datos GIS]] de un agente.

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --insert_gis_data 1 2 3 4


</code>

<WRAP center round important 75%>

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

</WRAP>


==== get_gis_agent ====

**Parámetros obligatorios**:

   * < id_del_agente >

**Parámetros opcionales**:

  * <font inherit/inherit;;inherit;;rgb(251, 250, 249)>Ninguno.</font>

**Descripción**:  Obtiene los [[:es:documentation:pandorafms:monitoring:20_gis|datos GIS]] de un agente.

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --get_gis_agent 1


</code>

<WRAP center round important 75%>

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

</WRAP>

==== 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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --agent_set_os 7 3 'Ubuntu 16.04'
</code>

===== Módulos =====


==== create_data_module ====

**Parámetros obligatorios**:

  * < nombre_de_módulo >
  * < tipo_de_módulo >
  * < nombre_de_agente >
  * < descripción > Para omitir este parámetro se utiliza '' "" ''.
  * < grupo_módulo> Para omitir este parámetro se utiliza '' "" ''.
  * < mínimo > Para omitir este parámetro se utiliza '' "" ''.
  * < máximo > Para omitir este parámetro se utiliza '' "" ''.

**Parámetros opcionales**:

  - < 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.
  - < 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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

Ejemplo sencillo para el escalado de estados:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --create_data_module data_module_test generic_data 3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001

</code>

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

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

</code>

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

</code>

<WRAP center round info 60%>

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.

</WRAP>

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

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

Ejemplo sencillo para el escalado de estados:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --create_web_module web_module_test web_data 3f9c41953a072afa229aa0a7fe3a6203a1ecf86b40b8a13d8a7d9916f0210bb1 "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" "" 2001

</code>

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

<code>
task_begin
get http://pandorafms.com
task_end

</code>

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

</code>

==== 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 >
  * < timeout >
  * < retries >
  * < critical_instructions >
  * < warning_instructions >
  * < unknown_instructions >
  * < warning_inverse >
  * < critical_inverse >
  * ''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.
  * < 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, 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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

Ejemplo sencillo para el escalado de estados:

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

Otro ejemplo:

<code bash>
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

</code>

==== Create_network_component ====

**Parámetros**: <network_component_name> <network_component_group> <network_component_type> [<description> <module_interval> <max_value> <min_value> <snmp_community> <id_module_group> <max_timeout> <history_data> <min_warning> <max_warning> <str_warning> <min_critical> <max_critical> <str_critical> <min_ff_event> <post_process> <disabled_types_event> <each_ff> <min_ff_event_normal> <min_ff_event_warning> <min_ff_event_critical>]

**Descripción**: Se creará un componente de red. Opcionalmente se le podrá otorgar un puerto, una descripción, unos valores min y max, un valor post_process, un intervalo en segundos, unos valores warning min y max, unos valores critical min y max, y un valor history data.

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

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

**Notas**:

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

  * <enable_unknown_events>

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

  * <each_ff>
  * <ff_threshold_normal>
  * <ff_threshold_warning>
  * <ff_threshold_critical>

**Ejemplo**:

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

</code>

<WRAP center round important 75%>

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

</WRAP>


==== 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.
  * < critical_instructions >
  * < warning_instructions >
  * < unknown_instructions >
  * < warning_inverse >
  * < critical_inverse >
  * < 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 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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

Ejemplo sencillo para el escalado de estados:

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

Otro ejemplo:

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

</code>

==== create_plugin_module ====

**Parámetros obligatorios**:

  * < nombre_modulo >
  * < tipo_modulo >
  * < nombre_agente >
  * < dirección_modulo >
  * < puerto_modulo > valor numérico entre ''1'' y ''65535''.
  * < nombre_plugin >
  * < usuario >
  * < contraseña >
  * < 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 >
  * < timeout > 
  * < critical_instructions >
  * < warning_instructions >
  * < unknown_instructions >
  * < warning_inverse >
  * < critical_inverse > 
  * ''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.
  * < 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 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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

Ejemplo sencillo para el escalado de estados:

<code bash>
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

</code>

Otro ejemplo:

<code bash>
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

</code>

==== Get_module_group ====

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

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

**Ejemplo**:

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

</code>

==== Create_module_group ====

**Parámetros**:  <nombre_del_grupo>

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

**Ejemplo**:

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

</code>

==== Module_group_synch ====

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

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

**Ejemplo**:
<code>

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

</code>

<WRAP center round important 75%>

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

</WRAP>


==== Create_synthetic ====

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

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

**Ejemplos**
<code>

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

</code>

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

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

**Ejemplos**

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

</code>

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

<code>
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic suma_memoria arithmetic nodo51sp3 production1, ,AvailableMemory production2, ,AvailableMemory

</code>

<code>
pandora_manage /etc/pandora/pandora_server.conf --create_synthetic diferencia_trafico arithmetic nodo51sp3 nodo51sp3, ,InputTraffic nodo51sp3,-,OutputTraffic

</code>

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

**Ejemplos (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --delete_module 'My module' 'My agent'


</code>


==== Data_module ====

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

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

**Ejemplo**:

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

</code>

==== Get_module_data ====

(>=5.0)

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

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

**Ejemplo**:

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

</code>

==== Get_module_id ====

**Parametros**:  <agent_id> <module_name>

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

**Ejemplo**:

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

</code>

==== Get_module_custom_id ====

**Parametros**:  <agentmodule_id>

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

**Ejemplo**:

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

</code>

==== Set_module_custom_id ====

**Parametros**:  <agentmodule_id> [<custom_id>]

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

**Ejemplo**:

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

</code>

==== Delete_data ====

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

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

**Ejemplo**:
<code>

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

</code>

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

==== Update_module ====

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

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

Los campos posibles son:

  * **Comunes a cualquier módulo**: module_name, agent_name, description, module_group, min, max, post_process, history_data, interval, warning_min, warning_max, critical_min, critical_max, warning_str, critical_str, ff_threshold, each_ff, ff_threshold_normal, ff_threshold_warning, ff_threshold_critical, critical_instructions, warning_instructions, unknown_instructions, critical_instructions, warning_instructions, unknown_instructions
  * **Para los módulos de datos**: ff_timeout
  * **Para los módulos de red**: module_address, module_port
  * **Para los módulos de tipo SNMP**: module_address, module_port, version, community, oid, snmp3_priv_method, snmp3_priv_pass, snmp3_sec_level, snmp3_auth_method, snmp3_auth_user, snmp3_priv_pass
  * **Para los módulos de tipo plugin**: module_address, module_port, plugin_name, user, password, parameters
**Ejemplo**:

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

</code>

==== add_tag_to_module ====

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

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_tag_to_module 'Nombre de agente' 'Nombre de módulo' 'Nombre de etiqueta'

</code>

<WRAP center round important 75%>

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

</WRAP>


==== Get_agents_module_current_data ====

(>=5.0)

**Parámetros**:  <module_name>

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

**Ejemplo**:

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

</code>

==== Create_network_module_from_component ====

(>=5.0)

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

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

**Ejemplo**:

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

</code>

==== Create_data_module_from_local_component ====

(>=5.1)

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

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

**Ejemplo**:

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

</code>

==== Create_local_component ====

(>=5.1)

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

**Descripción**:  Crear un nuevo componente local.

**Ejemplo**:

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

</code>

==== Apply_module_template ====

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

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

</code>

===== Alertas =====

==== Create_template_module ====

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

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

**Ejemplo**:

<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_template_module plantilla001 'My module' 'Mi agente'

</code>

==== Delete_template_module ====

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

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

**Ejemplo**:

<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_template_module plantilla001 'My module' 'Mi agente'

</code>

==== Create_template_action ====

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

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

**Ejemplo**:

<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_template_action acción012 plantilla001 'My module' 'Mi agente' 0 4

</code>

==== Delete_template_action ====

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

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

**Ejemplo**:

<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_template_action acción012 plantilla001 'My module' 'Mi agente'

</code>

==== 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**:

<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_alerts

</code>

==== 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**:

<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_alerts

</code>

==== Create_alert_template ====

**Parámetros**:  <template_name> <condition_type_serialized> <time_from> <time_to> [<description> <group_name> <field1> <field2> <field3> <priority> <default_action> <days> <time_threshold> <min_alerts> <max_alerts> <alert_recovery> <field2_recovery> <field3_recovery> <condition_type_separator>]

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

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

Las posibilidades son las siguientes:

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

  * **Expresión regular**:
      * **Sintaxis**: <type>;<matches_value>;<value>
      * **Ejemplo**: regex;1;stopped|error (Alerta cuando el valor coincida con la expresión regular 'stopped|error')
  * **Máx. y mín.**:
      * **Sintaxis**: <type>;<matches_value>;<min_value>;<max_value>
      * **Ejemplo**: max_min;0;30;50 (Alerta cuando el valor está fuera del intervalo 30-50)
  * **Máx.**:
      * **Sintaxis**: <type>;<max_value>
      * **Ejemplo**: max;70 (Alerta cuando el valor es mayor de 70)
  * **Mín.**:
      * **Sintaxis**: <type>;<min_value> :
      * **Ejemplo**: min;30 (Alerta cuando el valor es menor de 30)
  * **Igual a**:
      * **Sintaxis**: <type>;<value>
      * **Ejemplo**: equal;0 (Alerta cuando el valor es igual a 0)
  * **Diferente de**:
      * **Sintaxis**: <type>;<value>
      * **Ejemplo**: not_equal;100 (Alerta cuando el valor es distinto de 100)
  * **Estado advertencia**:
      * **Sintaxis**: <type>
      * **Ejemplo**: warning (Alerta cuando el estado cambie a advertencia)
  * **Estado crítico**:
      * **Sintaxis**: <type>
      * **Ejemplo**: critical (Alerta cuando el estado cambie a crítico)
  * **Estado desconocido**:
      * **Sintaxis**: <type>
      * **Ejemplo**: unknown (Alerta cuando el estado cambie a desconocido)
  * **Estado distinto a normal**:
      * **Sintaxis**: <type>
      * **Ejemplo**: not_normal (Alerta cuando el estado sea distinto a normal -warning, critical, etc.-)
  * **En estado de cambio**:
      * **Sintaxis**: <type>;<matches_value>
      * **Ejemplo**: onchange;1 (Alerta cuando el valor cambie)
  * **Siempre**:
      * **Sintaxis**: <type>
      * **Ejemplo**: always (Alerta siempre)
**El campo <days>**: Son siete caracteres binarios que especifican los días de la semana cuando la alerta estará activada. p.e.: 0000011 para activar la alerta solo sábado y domingo.

**Example**:
<code>

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   @

</code>

==== Delete_alert_template ====

(>=5.0)

**Parámetros**:  <template_name>

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

**Example**:

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

</code>

==== Update_alert_template ====

(>=5.0)

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

**Descripción**:  Se actualizará un campo dado de una plantilla de alerta existente. Los campos posibles son los siguientes: name, description, type, matches_value, value, min_value, max_value, time_threshold(0-1), time_from, time_to, monday(0-1), tuesday(0-1), wednesday(0-1), thursday(0-1), friday(0-1), saturday(0-1), sunday(0-1), min_alerts, max_alerts, recovery_notify(0-1), field1, field2, field3, recovery_field2, recovery_field3, priority(0-4), default_action, group_name.

**Ejemplo**:

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

</code>

==== Get_alert_actions ====

(>=5.0)

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

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_alert_actions 'Action 1' ';' 'json'

</code>

<WRAP center round important 75%>

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

</WRAP>


==== Get_alert_actions_meta ====

(>=5.0)

<WRAP center round box>Esta característica está en el Command Center (Metaconsola).</WRAP>

**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. 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**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_alert_actions_meta  'Action 1' ';' 'json'

</code>

<WRAP center round important 75%>

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

</WRAP>


==== Create_alert_command ====

(>=5.0)

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

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

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

**Ejemplo**:

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

</code>

==== Get_alert_commands ====

(>=5.0)

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

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf  --get_alert_commands "command_name"

</code>

==== validate_alert ====

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

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf  --validate_alert 7 10 15

</code>


==== Validate_all_alerts ====

(>=5.0)

**Parámetros**:  None

**Descripción**:  Se validan todas las alertas.

**Ejemplo**:

<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_all_alerts

</code>

==== Create_special_day ====

(>=5.1)

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

**Descripción**:  Crear un día especial. Los posibles same_day son: lunes, martes, miércoles, jueves, viernes, sábado y domingo.

**Example**:

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

</code>

==== Delete_special_day ====

(>=5.1)

**Parámetros**:  <día_especial>

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

**Example**:

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

</code>

==== Update_special_day ====

(>=5.1)

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

**Descripción**: Modificar un campo específico de un día especial. Los campos que se puede actualizar son: same_day, description y group_name. Los posibles valores para same_day son: lunes, martes, miércoles, jueves, viernes, sábado y domingo.

**Example**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --update_special_day 2014-05-03 same_day monday

</code>

==== set_event_storm_protection ====

**Parámetros**: <valor>

**Descripción**: Habilita (''1'') o deshabilita (''0'') la [[:es:documentation:pandorafms:management_and_operation:01_alerts#proteccion_en_cascada|protección contra tormenta de eventos]].

**Example**:
<code>

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

</code>


===== Usuarios =====

==== create_user ====

<WRAP center round info 60%>

Esta función también trabaja en el Command Center (Metaconsola).

</WRAP>\\
**Parámetros obligatorios**:

   * < id_usuario >
  * < contraseña >
  * < es_admin >

**Parámetros opcionales**:

  * < comentarios >

**Descripción**:

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

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

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


</code>


==== delete_user ====

<WRAP center round info 60%>

Versión 766 o posterior: Esta función también trabaja en el Command Center (Metaconsola).

</WRAP>

**Parámetro obligatorio**:

   * < id_usuario >

**Descripción**:

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

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --delete_user user02

</code>


==== update_user ====

<WRAP center round info 60%>

Versión 766 o posterior: Esta función también trabaja en el Command Center (Metaconsola).

</WRAP>

**Parámetros obligatorios**:

   * < id_usuario >
  * < campo_a_actualizar >
  * < valor_nuevo >

**Descripción**:

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

  * ''email''  : correo electrónico.
  * ''phone''  : número de teléfono.
  * ''is_admin''  : ¿Es [[:es:documentation:pandorafms:introduction:03_glossary#superadmin|superadmin]]? (''0''  falso,''1''  verdadero).
  * ''language''  idioma, valores posibles:
      * ''default'', inglés Estados Unidos.
      * ''ca'', catalán.
      * ''en_GB'', inglés Reino Unido.
      * ''es'', español.
      * ''fr'', francés.
      * ''ru'', ruso.
      * ''ja'', japonés.
      * ''zh_CN''  , chino.
  * ''comments''  : Comentarios.
  * ''fullname''  : Nombre completo del usuario.
  * ''password''  : Contraseña del usuario, utilice comillas si contiene espacios.
**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --update_user 'usuario 9500' password 'XYZ'

</code>


==== enable_user ====

<WRAP center round info 60%>

Versión 766 o posterior: Esta función también trabaja en el Command Center (Metaconsola).

</WRAP>

**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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage.pl /etc/pandora/pandora_server.conf –enable_user 'user 9500'

</code>


==== disable_user ====

<WRAP center round info 60%>

Versión 766 o posterior: Esta función también trabaja en el Command Center (Metaconsola).

</WRAP>

**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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage.pl /etc/pandora/pandora_server.conf --disable_user 'user 9500'


</code>


==== create_profile ====

<WRAP center round info 60%>

Versión 766 o posterior: Esta función también trabaja en el Command Center (Metaconsola).

</WRAP>

**Parámetros obligatorios**:

   * < nombre_perfil >
  * < lista_de_permisos > Utilice ''1''  ó ''0''  otorgar o negar permiso, respectivamente. Son numerados de esta manera:
      - Ver agentes (AR View agents).
      - Editar agentes (AW Edit agents).
      - Desactivar agentes (AD Disable agents).
      - Editar alertas (LW Edit alerts).
      - Gestionar alertas (LM Manage alerts).
      - Gestionar usuarios (UM Manage users).
      - Gestionar base de datos (DM Manage database).
      - Ver eventos (ER View events).
      - Editar eventos (EW Edit events).
      - Gestionar eventos (EM Manage events).
      - Ver informes (RR View reports).
      - Editar informes (RW Edit reports).
      - Gestionar informes (RM Manage reports).
      - Ver mapas (MR View network maps).
      - Editar mapas (MW Edit network maps).
      - Gestionar mapas (MM Manage network maps).
      - Ver consola visual (VR View visual console).
      - Editar consola visual (VW Edit visual console).
      - Gestionar consola virtual (VM Manage visual console).
      - Gestionar Pandora PFMS (PM Pandora FMS management).
      - Ver Network Config Management (**NR**  View NCM data).
      - Operar Network Config Management (**NW**  Operate NCM -debe incluir **NR**-).
      - Gestionar Network Config Management (**NM**  Manage NCM -debe incluir **NW**  y **NR**).

**Descripción**:

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

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --create_profile Profile01 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0


</code>


==== update_profile ====

<WRAP center round info 60%>

Versión 766 o posterior: Esta función también trabaja en el Command Center (Metaconsola).

</WRAP>

**Parámetros obligatorios**:

   * < nombre_perfil >
  * < lista_de_permisos > Utilice ''1''  ó ''0''  otorgar o negar permiso, respectivamente. Son numerados de esta manera:
      - Ver agentes (AR View agents).
      - Editar agentes (AW Edit agents).
      - Desactivar agentes (AD Disable agents).
      - Editar alertas (LW Edit alerts).
      - Gestionar alertas (LM Manage alerts).
      - Gestionar usuarios (UM Manage users).
      - Gestionar base de datos (DM Manage database).
      - Ver eventos (ER View events).
      - Editar eventos (EW Edit events).
      - Gestionar eventos (EM Manage events).
      - Ver informes (RR View reports).
      - Editar informes (RW Edit reports).
      - Gestionar informes (RM Manage reports).
      - Ver mapas (MR View network maps).
      - Editar mapas (MW Edit network maps).
      - Gestionar mapas (MM Manage network maps).
      - Ver consola visual (VR View visual console).
      - Editar consola visual (VW Edit visual console).
      - Gestionar consola virtual (VM Manage visual console).
      - Gestionar Pandora PFMS (PM Pandora FMS management).
      - Ver Network Config Management (**NR**  View NCM data).
      - Operar Network Config Management (**NW**  Operate NCM -debe incluir **NR**-).
      - Gestionar Network Config Management (**NM**  Manage NCM -debe incluir **NW**  y **NR**).

**Descripción**:

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

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --update_profile Profile01 1 0 1 0 1 0 1 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0


</code>


==== add_profile ====

<WRAP center round info 60%>

Versión 766 o posterior: Esta función también trabaja en el Command Center (Metaconsola).

</WRAP>

**Parámetros obligatorios**:

   * < id_usuario >
  * < nombre_perfil >
  * < nombre_grupo >

**Descripción**:

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

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage.pl /etc/pandora/pandora_server.conf --add_profile user02 'Group coordinator' All

</code>


==== add_tag_to_user_profile ====

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

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_tag_to_user_profile '7' 'nueva etiqueta' 'All' 'Perfil del usuario 7'

</code>

<WRAP center round important 75%>

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

</WRAP>


==== delete_profile ====

<WRAP center round info 60%>

Versión 766 o posterior: Esta función también trabaja en el Command Center (Metaconsola).

</WRAP>

**Parámetros obligtorios**:

   * < id_usuario >
  * < nombre_perfil >
  * < nombre_grupo >

**Descripción**:

Se eliminará un perfil de un usuario pasándole como parámetro el nombre de usuario, el nombre del perfil y el nombre del grupo sobre el que tiene los privilegios el perfil. Si el perfil a eliminar está asociado al grupo ''All'' debe especificar como grupo ''All''.

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --delete_profile user02 'Chief Operator' Applications

</code>


==== add_profile_to_user ====

<WRAP center round info 60%>

Versión 766 o posterior: Esta función también trabaja en el Command Center (Metaconsola).

</WRAP>

**Parámetros obligatorios**:

   * < id_usuario >
  * < nombre_perfil >

**Parámetro opcional**:

  * < nombre_grupo >

**Descripción**:

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

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --add_profile_to_user 'user01' 'Chief Operator' 'Network'

</code>


==== disable_eacl ====

**Parámetros**: Ninguno.

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --disable_eacl

</code>


==== enable_eacl ====

**Parámetros**: Ninguno.

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --enable_eacl

</code>


==== disable_double_auth ====

**Parámetro obligatorio**: <id_usuario>

**Descripción**: Se desactivará la [[:es:documentation:pandorafms:management_and_operation:12_console_setup#doble_autenticacion|doble autenticación]] del usuario elegido.

**Ejemplo**:
<code>

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

</code>


===== Events =====

==== create_event ====

**Parámetros obligatorios**:

   * Nombre del evento.
  * Tipo de evento. Podrá tomar alguno de estos valores:
      * ''unknown''  , ''alert_fired''  , ''alert_recovered''  , ''alert_ceased''  , ''alert_manual_validation''  , ''recon_host_detected''  , ''system''  , ''error''  , ''new_agent''  , ''going_up_warning''  , ''going_up_critical''  , ''going_down_normal'' , ''going_down_warning'', ''going_down_critical''  , ''going_up_normal''  , ''configuration_change''  .
  * Nombre de grupo.

**Parámetros opcionales**:

  * Nombre del agente.
  * Nombre del módulo.
  * Estado del evento (''0''  si **no**  está validado, ''1''  si está validado y ''2''  en proceso).
  * Severidad: ''0''  (Mantenimiento), ''1''  (Informativo), ''2''  (Normal), ''3''  (Advertencia), ''4''  (Crítica), ''5''  (Menor) y ''6''  (Mayor).
  * Nombre de la plantilla en el caso de que esté asociado a una alerta.
  * Nombre de usuario.
  * Comentario.
  * Fuente.
  * Identificador adicional.
  * Etiquetas: El formato de las etiquetas debe ser <etiqueta> <url>. Se pueden añadir varias etiquetas separadas por comas: < etiqueta > < url >,< etiqueta > < url >. //Es importante que no haya espacios entre la coma y la siguiente etiqueta//.
  * Datos personalizados: Los datos personalizados se introducen como un documento JSON. Por ejemplo: ''{"Location": "Office", "Priority": 42}''  .
  * Forzar creación de agente (//bool//): Si el parámetro de nombre del agente hace referencia a un agente que no existe, entonces será creado.
  * Instrucciones en crítico: Añade las instrucciones a realizar en caso de pasar a estado crítico.
  * Instrucciones en advertencia: Añade las instrucciones a realizar en caso de pasar a estado de advertencia.
  * Instrucciones en desconocido: Añade las instrucciones a realizar en caso de pasar a estado desconocido.
  * Usar alias del agente, utilice textualmente ''use_alias''. //Se deben especificar dos comillas simples juntas, sin espacio entre ellas) si utiliza el siguiente parámetro a continuación//.
  * **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 [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

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


</code>


==== Validate_event ====

**Parámetros**:  <nombre_agente> <nombre_modulo> <fechahora_min> <fechahora_max> <nombre_usuario> <criticidad> <nombre_plantilla> <use_agent_alias> **Descripción**:  Se validarán todos los eventos atendiendo a una serie de filtros. Los filtros configurables son el nombre del agente, el nombre del módulo, una fecha-hora mínima y una fecha-hora máxima, el nombre de usuario, la criticidad y el nombre de la plantilla asociada. Se pueden combinar los parámetros de muchas maneras, dejando en blanco con comillas vacías <nowiki>(//)</nowiki> los que no se quieran utilizar y rellenando los demás. **Ejemplo**:

<code>perl pandora_manage.pl /etc/pandora/pandora_server.conf --validate_event 'Mi agente' 'My module'  '2010-06-02 22:02'

</code>

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


==== Validate_event_id ====

(>=5.0)

**Parámetros**:  <id_evento>

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

**Ejemplo**:

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

</code>

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

==== Get_event_info ====

(>=5.0)

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

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

**Ejemplo**:
<code>

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

</code>

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

==== add_event_comment ====

**Parámetros obligatorios**:

   * < id_evento >
  * < id_user >
  * < comentario >

**Descripción**:

Añade un comentario a un evento.

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --add_event_comment 1234 admin TEXT

</code>

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


==== event_in_progress ====

**Parámetros**: <id_evento>

**Descripción**: Pone un evento en progreso.

**Example**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --event_in_progress 123

</code>

<WRAP center round important 75%>

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

</WRAP>

==== update_event_custom_id ====

**Parámetros obligatorios**:

  * < id_evento >
  * < id_personalizado_de_evento >

**Descripción**:

Añade un identificador personalizado a un evento.

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

<code bash>
pandora_manage /etc/pandora/pandora_server.conf --update_event_custom_id '232' 'CLI test'

</code>

===== Policies =====

==== Create_policy ====

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

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

**Ejemplo**:

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

</code>

==== Apply_policy ====

**Parámetros**: <nombre_política>

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

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

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

**Ejemplo**:

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

</code>

<WRAP center round important 75%>

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

</WRAP>


==== Apply_all_policies ====

(>=5.0)

**Parámetros**:  None

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

**Ejemplo**:
<code>

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

</code>

==== Add_agent_to_policy ====

(>=5.0)

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

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

**Ejemplo**:

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

</code>

==== Add_collection_to_policy ====

**Parámetros**: <nombre_politica> <nombre_coleccion>

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_collection_to_policy 'Nombre política' 'Nombre colección'

</code>

==== recreate_collection ====

**Parámetros**: <id_de_colección_de_ficheros>

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

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

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

**Ejemplo**:
<code>

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

</code>


==== Create policy data module from local component ====

**Parámetros**:  <nombre_politica> <nombre_componente>

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

**Ejemplo**:

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

</code>

==== delete_not_policy_modules ====

**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**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_not_policy_modules

</code>


==== Remove_agent_from_policy ====

**Parámetros**: <id_policy> <id_agent>

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --remove_agent_from_policy '11' '2'

</code>

<WRAP center round important 75%>

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

</WRAP>


==== Disable_policy_alerts ====

**Parámetros**:  <nombre_política>

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

**Ejemplo**:

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

</code>

==== create_policy_data_module ====

**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 [[#create_data_module|son los mismos que para la opción --create_data_module]].

**Ejemplo**:

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

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

</code>

==== create_policy_web_module ====

**Parámetros obligatorios**:

  * < nombre_política >
  * < nombre_modulo >
  * < tipo_modulo >

**Parámetros opcionales**:

  * < descripción >
  * < grupo_modulo >
  * < min >
  * < max >
  * < post_process >
  * < intervalo >
  * < warning_min >
  * < warning_max >
  * < critical_min >
  * < critical_max >
  * < history_data >
  * < retries >
  * < requests >
  * < agent_browser_id >
  * < auth_server >
  * < auth_realm >
  * < configuration_data >
  * < proxy_url >
  * < proxy_auth_login >
  * < proxy_auth_password >
  * < warning_str >
  * < critical_str >
  * < enable_unknown_events >
  * < ff_threshold >
  * < each_ff >
  * < ff_threshold_normal >
  * < ff_threshold_warning >
  * < ff_threshold_critical >
  * < ff_timeout >
  * < warning_inverse >
  * < critical_inverse >
  * < critical_instructions >
  * < warning_instructions >
  * < unknown_instructions >
  * ''ignore_unknown'' Descarta el cálculo de estado desconocido, de manera que el módulo nunca cambiará a dicho estado y conservará siempre el último estado conocido.

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

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

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

</code>

==== create_policy_network_module ====

**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 [[#create_network_module|son los mismos que para la opción --create_network_module]].

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

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

</code>

==== create_policy_snmp_module ====

**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 [[#create_snmp_module|son los mismos que para la opción --create_snmp_module]].

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

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

</code>

==== create_policy_plugin_module ====

**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 [[#create_plugin_module|son los mismos que para la opción --create_plugin_module]].

**Ejemplo (véase la [[#ks1|llamada]] y su [[#ks1_1|sintaxis]])**:

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

</code>
==== Validate_policy_alerts ====

(>=5.0)

**Parámetros**:  <policy_name>

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

**Ejemplo**:

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

</code>

==== Get_policy_modules ====

(>=5.0)

**Parámetros**:  <policy_name>

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

**Ejemplo**:

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

</code>

==== Get_policies ====

(>=5.0)

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

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

**Ejemplo**:

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

</code>

===== Netflow =====

==== Create_netflow_filter ====

(>=5.0)

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

**Descripción**:  Crear un nuevo filtro de netflow.

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

**Ejemplo**:

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

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

</code>

===== Herramientas =====

==== Exec_from_file ====

(>=5.0)

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

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

**Ejemplo**:

Vamos a crear usuarios desde un fichero CSV.

Necesitamos un fichero CSV como éste:

<code>
 Usuario 1,Password 1,0
 Usuario 2,Password 2,0
 Usuario 3,Password 3,0
 Usuario Admin,Password Admin,1

</code>

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

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

Para hacer esto, ejecutaremos lo siguiente:

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

</code>

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

==== create_snmp_trap ====

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

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

**OID**: OID principal del trap.

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_snmp_trap Cisco_FAN_Crash 1.3.3.3.2.12.3.3.4.1 "Something happen with the FAN inside the CISCO device, probably a failure" 3

</code>

==== start_snmptrapd ====

**Parámetros**: Ninguno.

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

**Ejemplo**:
<code>
pandora_manage /etc/pandora/pandora_server.conf --start_snmptrapd

</code>


===== Gráficas =====

==== create_custom_graph ====

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

**Descripción**: Se creará una gráfica con los elementos especificados. Dos o más módulos deben ser distinguidos con <separador>, el cual siempre debe ser especificado, incluso para un solo módulo. //Todos los parámetros son obligatorios, pero algunos se pueden dejar vacíos mediantes comillas simples//. Si esto ocurre, los valores por defecto que toman los parámetros son los siguientes:

   * Ancho: ''550''.
  * Altura: ''210''.
  * Período: ''86400''  (en segundos).
  * Eventos: ''0''.
  * Tipo de gráfica: ''0''.
  * ID grupo: ''0''.

**Ejemplo**:

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

</code>


==== edit_custom_graph ====

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

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --edit_custom_graph 2 '' 'edit graph by CLI' '' '' '' '' '' '' 25200

</code>

{{  :wiki:pfms-pandorafms:technical_reference-03_anexo_cli-edit_custom_graph-img01.png  }}


==== add_modules_to_graph ====

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

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_modules_to_graph 2 '1015,1017' ','

</code>

{{  :wiki:pfms-pandorafms:technical_reference-03_anexo_cli-add_modules_to_graph-img01.png  }}


==== delete_modules_to_graph ====

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

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_modules_to_graph 2 '1015,1017' ','

</code>

{{  :wiki:pfms-pandorafms:technical_reference-03_anexo_cli-delete_modules_to_graph-img01.png  }}


===== Clústeres =====


==== new_cluster ====

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

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --new_cluster cluster1 AA description 12

</code>

<WRAP center round important 75%>

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

</WRAP>


==== add_cluster_agent ====

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

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

**Ejemplo **:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --add_cluster_agent W3siaWQiOjUsImlkX2FnZW50IjoyfSwKeyJpZCI6NSwiaWRfYWdlbnQiOjN9XQ==

</code>

<WRAP center round important 75%>

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

</WRAP>


==== add_cluster_item (active / active) ====

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

<code>
[
  {
    "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
  }
]

</code>

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

<WRAP center round important 60%>Es absolutamente necesario que los JSON se codifiquen en base 64.</WRAP>

 \\ **Ejemplo **:

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

</code>

<WRAP center round important 75%>

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

</WRAP>


==== add_cluster_item (active / pasive) ====

**Parámetros**:

Datos JSON con estos campos:

  * ''name''  : (valor de cadena de texto).
  * ''id_cluster''  : (valor numérico).
  * ''type''  : ''AP''  (significa "**Active/Pasive**").
  * ''critical_limit''  : (valor numérico).
  * ''warning_limit''  : (valor numérico).
**Ejemplo JSON**:

<code>
[
  {
    "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
  }
]

</code>

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

<WRAP center round important 60%>Es absolutamente necesario que los JSON se codifiquen en base 64.</WRAP>

 \\ **Ejemplo**:

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

</code>


==== get_cluster_status ====

**Parámetros**: <identificador_de_clúster>

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --get_cluster_status 7

</code>

<WRAP center round important 75%>

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

</WRAP>


==== delete_cluster ====

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

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_cluster 1

</code>

<WRAP center round important 75%>

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

</WRAP>


==== delete_cluster_agent ====

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

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_cluster_agent 1 1

</code>

<WRAP center round important 75%>

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

</WRAP>


==== delete_cluster_item ====

**Parámetros**: <id_item>

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --delete_cluster_item 1

</code>

<WRAP center round important 75%>

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

</WRAP>


===== Consolas visuales =====

==== create_visual_console ====

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

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

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

**Ejemplo (auto_creation)**:

<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_visual_console 'test console' 'mapamundo.jpg' 1024 768 12 'auto_creation' '{"pos1x":0,"pos1y":60,"pos2x":800,"pos2y":600}' '#FFF' '[{"image": "_engine","height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 1,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"},{"image": "_printer","height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 2,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"}]'

</code>

**Ejemplo (static_objects)**:

<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_visual_console 'test console' 'mapamundo.jpg' 1024 768 12 'static_objects' "" '#FFF' '[{"image": "_engine","pos_x":100,"pos_y":100,"height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 1,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"},{"image": "_printer","pos_x":400,"pos_y":100,"height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 2,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"}]'

</code>

==== edit_visual_console ====

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

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

**Ejemplo (auto_creation)**:

<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --edit_visual_console 1 'test console edited'     'auto_creation' {"pos1x":0,"pos1y":60,"pos2x":800,"pos2y":600}  '[{"id":103,"image": "_engine","height": 180,"width": 200,"label": "","type": 0,"period": 300,"id_agent": 3,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"},{"pos_x":400,"pos_y":100,"image": "_printer","height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 4,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"}]'

</code>

**Ejemplo (static_objects)**:

<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --edit_visual_console 1 'test console edited'     'static_objects'   '[{"id":103,"image": "_engine","height": 180,"width": 200,"label": "","type": 0,"period": 300,"id_agent": 3,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"},{"pos_x":400,"pos_y":100,"image": "_printer","height": 0,"width": 0,"label": "","type": 0,"period": 300,"id_agent": 4,"id_agente_modulo": 0,"id_group": 0,"id_layout_linked": 0,"parent_item": 0,"enable_link": 1,"id_metaconsole": 0,"id_custom_graph": 0,"border_width": 0,"border_color": "","fill_color": "","type_graph": "area","label_position": "down"}]'

</code>

==== delete_visual_console ====

**Parámetros**:  <id>

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

**Ejemplo**:

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

</code>

==== delete_visual_console_objects ====

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

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

**Ejemplo**:

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

</code>

==== duplicate_visual_console ====

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

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

**Ejemplo**:

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

</code>

==== export_json_visual_console ====

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

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

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

**Ejemplo**:

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

</code>

===== Otras =====



==== locate_agent ====

**Parámetros**: <nombre_agente> [ ''use_alias'' ]

**Descripción**: Busca un agente en los nodos de una el Command Center (Metaconsola) y devuelve el ID de esta.

**Ejemplo**:
<code>

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

</code>

==== create_tag ====

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

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

**Ejemplo**:
<code>
perl pandora_manage.pl /etc/pandora/pandora_server.conf --create_tag 'Nuevo nombre de etiqueta' 'Su descripción para la etiqueta'

</code>

<WRAP center round important 75%>

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

</WRAP>

[[:es:documentation:start|Volver al Índice de Documentación Pandora FMS]]