Difference between revisions of "Pandora: Documentation es: Anexo API external"

From Pandora FMS Wiki
Jump to: navigation, search
(set apply_policy)
(API externa de Pandora FMS)
Line 1: Line 1:
 
[[Pandora:Documentation|Volver a Indice de Documentacion Pandora FMS]]
 
[[Pandora:Documentation|Volver a Indice de Documentacion Pandora FMS]]
  
= API externa de Pandora FMS =
+
= Introducción =
  
 
La API externa de Pandora FMS se utiliza haciendo llamadas remotas (via HTTP) sobre el fichero '''/include/api.php'''. Este es el método que se ha definido en Pandora FMS para integrar aplicaciones de terceros con Pandora FMS. Básicamente consiste en un llamada con los parámetros formateados para recibir un valor o una lista de valores que después su aplicación usará para realizar operaciones.
 
La API externa de Pandora FMS se utiliza haciendo llamadas remotas (via HTTP) sobre el fichero '''/include/api.php'''. Este es el método que se ha definido en Pandora FMS para integrar aplicaciones de terceros con Pandora FMS. Básicamente consiste en un llamada con los parámetros formateados para recibir un valor o una lista de valores que después su aplicación usará para realizar operaciones.
Line 28: Line 28:
 
:*csv_head: devuelve, igual que con "csv", salvo que añade una primera fila con los nombres de los campos a retornar.
 
:*csv_head: devuelve, igual que con "csv", salvo que añade una primera fila con los nombres de los campos a retornar.
  
==Seguridad==
+
=Seguridad=
 
 
 
Actualmente, la seguridad se basa en una lista de IPs que tendrán acceso a la herramienta. Y se podrá configurar como se ve en la imagen, en las opciones de configuración de Pandora Console.
 
Actualmente, la seguridad se basa en una lista de IPs que tendrán acceso a la herramienta. Y se podrá configurar como se ve en la imagen, en las opciones de configuración de Pandora Console.
  
Line 58: Line 57:
 
'''Nota: Las llamadas a la API llevan las contraseñas sin codificar. Por lo que se debería tener cuidado y emplear conexiones SSL para evitar que se puedan ver en la red. La API admite peticiones via POST para poder cifrarlas cuando se usa SSL/HTTPS.'''
 
'''Nota: Las llamadas a la API llevan las contraseñas sin codificar. Por lo que se debería tener cuidado y emplear conexiones SSL para evitar que se puedan ver en la red. La API admite peticiones via POST para poder cifrarlas cuando se usa SSL/HTTPS.'''
  
=== Retorno ===
+
== Retorno ==
 
 
 
Cuando la API denega el acceso, será devuelta una simple cadena de texto "auth error".
 
Cuando la API denega el acceso, será devuelta una simple cadena de texto "auth error".
  
=== Ejemplos ===
+
== Ejemplos ==
 
 
 
En este caso, se está utilizando la password del API ''1234'' y se está accediendo con el usuario ''admin'' y la password ''pandora''.
 
En este caso, se está utilizando la password del API ''1234'' y se está accediendo con el usuario ''admin'' y la password ''pandora''.
  
Line 74: Line 71:
 
* El usuario ''admin'' existe y su password es ''pandora''
 
* El usuario ''admin'' existe y su password es ''pandora''
  
=== Workflow del sistema de seguridad ===
+
== Workflow del sistema de seguridad ==
 
 
 
'''A partir de la versión 4.0.2''', la API tiene algunas mejoras en el manejo de la seguridad. Esto se implementa ahora gracias a tres elementos:
 
'''A partir de la versión 4.0.2''', la API tiene algunas mejoras en el manejo de la seguridad. Esto se implementa ahora gracias a tres elementos:
  
Line 88: Line 84:
 
</center><br><br>
 
</center><br><br>
  
==Extensión de nuevas llamadas en el API==
+
=Extensión de nuevas llamadas en el API=
 
 
 
Para desarrollar nuevas llamadas para el API tiene que tener en cuenta que:
 
Para desarrollar nuevas llamadas para el API tiene que tener en cuenta que:
  
Line 102: Line 97:
 
*returnType: string que especifica el tipo de retorno que tendrá la llamada. En principio es transparente para usted, pero puede usarlo o modificarlo si fuese necesario.
 
*returnType: string que especifica el tipo de retorno que tendrá la llamada. En principio es transparente para usted, pero puede usarlo o modificarlo si fuese necesario.
  
=== Nuevas llamadas en el API desde las extensiones de Pandora FMS ===
+
== Nuevas llamadas en el API desde las extensiones de Pandora FMS ==
 
 
 
Es posible crear nuevas llamadas del API sin utilizar /include/functions_api.php. La forma de hacerlo es añadiendo en el directorio de una extensión de Pandora FMS un fichero con el siguiente nombre: <nombre_de_la_extension>.api.php y dentro de este fichero crear las funciones deseadas con las mismas consideraciones de la API estándar pero con el prefijo "apiextension" en lugar de "api".
 
Es posible crear nuevas llamadas del API sin utilizar /include/functions_api.php. La forma de hacerlo es añadiendo en el directorio de una extensión de Pandora FMS un fichero con el siguiente nombre: <nombre_de_la_extension>.api.php y dentro de este fichero crear las funciones deseadas con las mismas consideraciones de la API estándar pero con el prefijo "apiextension" en lugar de "api".
  
Line 112: Line 106:
 
En este fichero estarán las funciones deseadas, por ejemplo una función para obtener el número de módulos de un grupo. Esta función debe tener un nombre parecido a: "apiextension_get_groupmodules".
 
En este fichero estarán las funciones deseadas, por ejemplo una función para obtener el número de módulos de un grupo. Esta función debe tener un nombre parecido a: "apiextension_get_groupmodules".
  
==== Ejemplo de función ====
+
=== Ejemplo de función ===
 
 
 
En esta función se han usado funciones imaginarias.
 
En esta función se han usado funciones imaginarias.
  
Line 129: Line 122:
 
</pre></code>
 
</pre></code>
  
==== Ejemplo de llamada ====
+
=== Ejemplo de llamada ===
 
 
 
En esta llamada se obtiene el número de módulos del grupo "Servers"
 
En esta llamada se obtiene el número de módulos del grupo "Servers"
  
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=extension&ext_name=module_groups&ext_function=groupmodules&id=Servers&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=extension&ext_name=module_groups&ext_function=groupmodules&id=Servers&apipass=1234&user=admin&pass=pandora</nowiki>
  
===Funciones API===
+
==Funciones API==
 
 
 
Las siguientes funciones las puede usar en el código de la función de su llamada :
 
Las siguientes funciones las puede usar en el código de la función de su llamada :
  
Line 149: Line 140:
 
::*'data' (obligatorio): contiene o un string con el dato o un array de índice alfanuméricos o numéricos con los datos.
 
::*'data' (obligatorio): contiene o un string con el dato o un array de índice alfanuméricos o numéricos con los datos.
  
===Ejemplo===
+
==Ejemplo==
 
 
 
<code><pre>
 
<code><pre>
 
function api_get_module_last_value($idAgentModule, $trash1, $other = ';', $returnType)
 
function api_get_module_last_value($idAgentModule, $trash1, $other = ';', $returnType)
Line 182: Line 172:
 
</pre></code>
 
</pre></code>
  
==Llamadas al API==
+
=Llamadas al API=
 
 
 
Se dividen en dos grupos según si devuelven o escriben datos en Pandora FMS.
 
Se dividen en dos grupos según si devuelven o escriben datos en Pandora FMS.
  
 
Existe una excepción: La llamada de retorno de información.
 
Existe una excepción: La llamada de retorno de información.
  
===RETORNO DE INFORMACIÓN===
+
==RETORNO DE INFORMACIÓN==
 
 
 
Devuelve la versión de Pandora Console, de un modo parecido a la función ''get test'' pero sin chequear la conexión al API.
 
Devuelve la versión de Pandora Console, de un modo parecido a la función ''get test'' pero sin chequear la conexión al API.
  
Line 200: Line 188:
 
Un ejemplo de respuesta podría ser: ''Pandora FMS v5.0 - PC131015''
 
Un ejemplo de respuesta podría ser: ''Pandora FMS v5.0 - PC131015''
  
===GET===
+
==GET==
 
 
 
Devuelve los datos solicitados.
 
Devuelve los datos solicitados.
  
====get test====
+
===get test===
 
Chequea la conexión al API y devuelve la versión del Pandora Console.
 
Chequea la conexión al API y devuelve la versión del Pandora Console.
  
Line 213: Line 200:
 
Sin parámetros
 
Sin parámetros
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
Este ejemplo devolverá OK,[version],[build]
 
Este ejemplo devolverá OK,[version],[build]
  
Line 221: Line 207:
 
Un ejemplo de respuesta podría ser: ''OK,v4.0.2,PC120614''
 
Un ejemplo de respuesta podría ser: ''OK,v4.0.2,PC120614''
  
====get all_agents====
+
===get all_agents===
 
Devuelve la lista de agentes filtrados por los filtros seteados en other.
 
Devuelve la lista de agentes filtrados por los filtros seteados en other.
  
Line 236: Line 222:
 
:*&lt;csv_separator&gt;
 
:*&lt;csv_separator&gt;
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
Este ejemplo devolverá todos los agentes cuyo id_so sea igual a 1, id_group igual a 2, estado de warning, su alias contenga 'j', y su política asociada tenga id igual a 2.
 
Este ejemplo devolverá todos los agentes cuyo id_so sea igual a 1, id_group igual a 2, estado de warning, su alias contenga 'j', y su política asociada tenga id igual a 2.
  
Line 244: Line 229:
 
</nowiki>
 
</nowiki>
  
====get module_last_value====
+
===get module_last_value===
 
Devuelve el último valor de un módulo, el cual se selecciona por el ID pasado por el parámetro id. Con el parámetro other puede añadir el código de error para que tu aplicación detecte este valor fuera del rango de valores del módulo.
 
Devuelve el último valor de un módulo, el cual se selecciona por el ID pasado por el parámetro id. Con el parámetro other puede añadir el código de error para que tu aplicación detecte este valor fuera del rango de valores del módulo.
  
Line 257: Line 242:
 
::*'error_value'&lt;separador&gt;&lt;código o valor&gt devuelve ese código o valor de error. Pero es necesario acompañarlo de 'other_mode' tal que así other_mode=url_encode_separator_&lt;separador&gt; para pasar el separador en other.
 
::*'error_value'&lt;separador&gt;&lt;código o valor&gt devuelve ese código o valor de error. Pero es necesario acompañarlo de 'other_mode' tal que así other_mode=url_encode_separator_&lt;separador&gt; para pasar el separador en other.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_last_value&id=63&other=error_value|0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_last_value&id=63&other=error_value|0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_last_value&id=62&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_last_value&id=62&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get agent_module_name_last_value====
+
===get agent_module_name_last_value===
 
Devuelve el último valor de un módulo, el cual se selecciona por nombre del agente pasado por el parámetro id y nombre del módulo pasado por el id2. Con el parámetro other puede añadir el código de error para que tu aplicación detecte este valor fuera del rango de valores que puede ser el módulo.
 
Devuelve el último valor de un módulo, el cual se selecciona por nombre del agente pasado por el parámetro id y nombre del módulo pasado por el id2. Con el parámetro other puede añadir el código de error para que tu aplicación detecte este valor fuera del rango de valores que puede ser el módulo.
  
Line 276: Line 260:
 
::*'error_value'&lt;separador&gt;&lt;código o valor&gt devuelve ese código o valor de error. Pero es necesario acompañarlo de 'other_mode' tal que así other_mode=url_encode_separator_&lt;separador&gt; para pasar el separador en other.
 
::*'error_value'&lt;separador&gt;&lt;código o valor&gt devuelve ese código o valor de error. Pero es necesario acompañarlo de 'other_mode' tal que así other_mode=url_encode_separator_&lt;separador&gt; para pasar el separador en other.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_module_name_last_value&id=user&id2=cpu_user&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_module_name_last_value&id=user&id2=cpu_user&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get agent_module_name_last_value_alias====
+
===get agent_module_name_last_value_alias===
 
>= 7.0NG
 
>= 7.0NG
  
Line 296: Line 279:
 
::*'error_value'&lt;separador&gt;&lt;código o valor&gt devuelve ese código o valor de error. Pero es necesario acompañarlo de 'other_mode' tal que así other_mode=url_encode_separator_&lt;separador&gt; para pasar el separador en other.
 
::*'error_value'&lt;separador&gt;&lt;código o valor&gt devuelve ese código o valor de error. Pero es necesario acompañarlo de 'other_mode' tal que así other_mode=url_encode_separator_&lt;separador&gt; para pasar el separador en other.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_module_name_last_value_alias&id=pandorafms&id2=Memory_Used&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_module_name_last_value_alias&id=pandorafms&id2=Memory_Used&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get module_value_all_agents====
+
===get module_value_all_agents===
 
Devuelve una lista de agentes y el valor para el módulo, este módulo lo tienen todos los agentes y es pasado el nombre como parámetro id.
 
Devuelve una lista de agentes y el valor para el módulo, este módulo lo tienen todos los agentes y es pasado el nombre como parámetro id.
  
Line 310: Line 292:
 
*id=&lt;name of the module&gt; (obligatorio) contiene el nombre del módulo.
 
*id=&lt;name of the module&gt; (obligatorio) contiene el nombre del módulo.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_value_all_agents&id=example_module_name&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_value_all_agents&id=example_module_name&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get agent_modules====
+
===get agent_modules===
 
Devuelve la lista de módulos de un agente filtrado por el id del agente pasado como parámetro id.
 
Devuelve la lista de módulos de un agente filtrado por el id del agente pasado como parámetro id.
  
Line 326: Line 307:
 
Pero es necesario acompañarlo de 'other_mode' tal que así other_mode=url_encode_separator_&lt;separador&gt; para pasar el separador en other.
 
Pero es necesario acompañarlo de 'other_mode' tal que así other_mode=url_encode_separator_&lt;separador&gt; para pasar el separador en other.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_modules&return_type=csv&other=14&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_modules&return_type=csv&other=14&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get module_id====
+
===get module_id===
 
Devuelve la id de un módulo concreto de un agente.
 
Devuelve la id de un módulo concreto de un agente.
  
Line 340: Line 320:
 
*other=nombre del modulo (obligatorio)
 
*other=nombre del modulo (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_id&id=5&other=Host%20Alive&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_id&id=5&other=Host%20Alive&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get locate_agent====
+
===get locate_agent===
 
Obtiene el id del servidor donde se encuentra el agente, e imprime todo el resultado como un archivo csv.
 
Obtiene el id del servidor donde se encuentra el agente, e imprime todo el resultado como un archivo csv.
  
Line 355: Line 334:
 
*other_mode= other_mode=url_encode_separator_&lt;separador&gt (obligatorio)  
 
*other_mode= other_mode=url_encode_separator_&lt;separador&gt (obligatorio)  
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=locate_agent&return_type=csv&apipass=1234&user=admin&pass=pandora&id=Pepito&other_mode=url_encode_separator_%7C</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=locate_agent&return_type=csv&apipass=1234&user=admin&pass=pandora&id=Pepito&other_mode=url_encode_separator_%7C</nowiki>
  
====get policies====
+
===get policies===
 
Devuelve la lista políticas de un agente pasado su id dentro del parámetro other.
 
Devuelve la lista políticas de un agente pasado su id dentro del parámetro other.
  
Line 370: Line 348:
 
:*&lt;id_agent&gt;
 
:*&lt;id_agent&gt;
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=policies&return_type=csv&other=&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=policies&return_type=csv&other=&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get tree_agents====
+
===get tree_agents===
 
Devuelve una completa lista organizada por grupos en el primer nivel, agentes el segundo nivel y módulos el tercer nivel. Esta lista se filtra por el parámetro other.
 
Devuelve una completa lista organizada por grupos en el primer nivel, agentes el segundo nivel y módulos el tercer nivel. Esta lista se filtra por el parámetro other.
  
Line 519: Line 496:
 
::::*alert_actions_id_group'
 
::::*alert_actions_id_group'
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=tree_agents&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=tree_agents&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=tree_agents&return_type=csv&other=;|%20|type_row,group_id,agent_name&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=tree_agents&return_type=csv&other=;|%20|type_row,group_id,agent_name&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get module_data====
+
===get module_data===
 
Devuelve una lista de valores de un módulo, este módulo se filtra por el id pasado por el parámetro id. Y la lista de valores es desde la fecha actual hasta el límite del periodo pasado como segundo parámetro en el other, el primero es el separador de CSV.
 
Devuelve una lista de valores de un módulo, este módulo se filtra por el id pasado por el parámetro id. Y la lista de valores es desde la fecha actual hasta el límite del periodo pasado como segundo parámetro en el other, el primero es el separador de CSV.
  
Line 538: Line 514:
 
::*tiempo de final (<año><mes><día>T<hora>:<minuto>)
 
::*tiempo de final (<año><mes><día>T<hora>:<minuto>)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_data&id=17&other=;|604800|20121201T13:40|20171215T13:40&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_data&id=17&other=;|604800|20121201T13:40|20171215T13:40&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get graph_module_data====
+
===get graph_module_data===
 
Devuelve la gráfica de un módulo como un fichero de imagen, generada con el método de la gráficas estáticas de Pandora FMS. Es necesario pasar el ancho, alto, periodo, nombre de la gráfica y fecha de comienzo (sabiendo que en Pandora FMS la fecha que se indica en las gráficas siempre es la del final de los datos), pasados todos ellos como other parámetro.
 
Devuelve la gráfica de un módulo como un fichero de imagen, generada con el método de la gráficas estáticas de Pandora FMS. Es necesario pasar el ancho, alto, periodo, nombre de la gráfica y fecha de comienzo (sabiendo que en Pandora FMS la fecha que se indica en las gráficas siempre es la del final de los datos), pasados todos ellos como other parámetro.
  
Line 557: Line 532:
 
:*&lt;start_date&gt;
 
:*&lt;start_date&gt;
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=graph_module_data&id=17&other=604800|555|245|example|2009-12-07&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=graph_module_data&id=17&other=604800|555|245|example|2009-12-07&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get events====
+
===get events===
 
Devuelve la lista de eventos filtrados por el parámetro other.
 
Devuelve la lista de eventos filtrados por el parámetro other.
  
Line 588: Line 562:
 
:*&lt;event type&gt; unknown, alert_fired, alert_recovered,.. o subcadena. Puedes usar 'not_normal'.
 
:*&lt;event type&gt; unknown, alert_fired, alert_recovered,.. o subcadena. Puedes usar 'not_normal'.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=events&return_type=csv&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=events&return_type=csv&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=events&other_mode=url_encode_separator_|&return_type=csv&other=;|2|SERVER|CPU|template_alert00||1274715715|127471781&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=events&other_mode=url_encode_separator_|&return_type=csv&other=;|2|SERVER|CPU|template_alert00||1274715715|127471781&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get all_alert_templates====
+
===get all_alert_templates===
 
 
 
Devuelve la lista de plantillas de alertas definidas en el Pandora FMS.
 
Devuelve la lista de plantillas de alertas definidas en el Pandora FMS.
  
Line 603: Line 575:
 
*other=cvs_separator (opcional)
 
*other=cvs_separator (opcional)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_alert_templates&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_alert_templates&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get module_groups====
+
===get module_groups===
 
Devuelve la lista de grupos de módulos.
 
Devuelve la lista de grupos de módulos.
  
Line 616: Line 587:
 
*other=cvs_separator (opcional)
 
*other=cvs_separator (opcional)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_groups&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_groups&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get plugins====
+
===get plugins===
 
Devuelve la lista de plugins de servidor de Pandora FMS.  
 
Devuelve la lista de plugins de servidor de Pandora FMS.  
  
Line 629: Line 599:
 
*other=cvs_separator (opcional)
 
*other=cvs_separator (opcional)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=plugins&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=plugins&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get tags====
+
===get tags===
 
Devuelve la lista de tags definida en Pandora.
 
Devuelve la lista de tags definida en Pandora.
  
Line 641: Line 610:
 
*return_type=csv (obligatorio)
 
*return_type=csv (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
Este ejemplo devolverá todos los tags del sistema.
 
Este ejemplo devolverá todos los tags del sistema.
  
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=tags&return_type=csv&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=tags&return_type=csv&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get module_from_conf====
+
===get module_from_conf===
 
>= 5.0 (Sólo Enterprise)
 
>= 5.0 (Sólo Enterprise)
  
Line 658: Line 626:
 
*id2=&lt;nombre módulo&gt; (obligatorio)
 
*id2=&lt;nombre módulo&gt; (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_from_conf&apipass=1234&user=admin&pass=pandora&id=9043&id2=example_name</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_from_conf&apipass=1234&user=admin&pass=pandora&id=9043&id2=example_name</nowiki>
  
 
Si no se encuentra el módulo se retornará cadena vacía
 
Si no se encuentra el módulo se retornará cadena vacía
  
====get total_modules====
+
===get total_modules===
 
Devuelve el número total de módulos de un grupo.
 
Devuelve el número total de módulos de un grupo.
  
Line 671: Line 639:
 
*id=&lt;id grupo&gt; (obligatorio)
 
*id=&lt;id grupo&gt; (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=total_modules&id=2&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=total_modules&id=2&apipass=1234&user=admin&pass=pandora</nowiki>
  
Line 677: Line 645:
 
Si se pone 0 como id de grupo, retornará el número total de módulos.
 
Si se pone 0 como id de grupo, retornará el número total de módulos.
  
====get total_agents====
+
===get total_agents===
 
Devuelve el número total de agentes de un grupo.
 
Devuelve el número total de agentes de un grupo.
  
Line 685: Line 653:
 
*id=&lt;id grupo&gt; (obligatorio)
 
*id=&lt;id grupo&gt; (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=total_agents&id=2&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=total_agents&id=2&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get agent_name====
+
===get agent_name===
 
Devuelve el nombre de un agente dado su identificador.
 
Devuelve el nombre de un agente dado su identificador.
  
Line 696: Line 664:
 
*id=&lt;id agente&gt; (obligatorio)
 
*id=&lt;id agente&gt; (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=agent_name&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=agent_name&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get agent_alias====
+
===get agent_alias===
 
>= 7.0NG
 
>= 7.0NG
  
Line 710: Line 678:
 
*id2=<id del nodo> (obligatorio en la metaconsola, innecesario en el nodo)
 
*id2=<id del nodo> (obligatorio en la metaconsola, innecesario en el nodo)
  
=====Ejemplos=====
+
====Ejemplos====
 
* Nodo:
 
* Nodo:
  
Line 719: Line 687:
 
  <nowiki>http://localhost/pandora_console/enterprise/meta/include/api.php?op=get&op2=agent_alias&id=1&id2=1&apipass=1234&user=admin&pass=pandora</nowiki><nowiki>Insert non-formatted text here</nowiki>
 
  <nowiki>http://localhost/pandora_console/enterprise/meta/include/api.php?op=get&op2=agent_alias&id=1&id2=1&apipass=1234&user=admin&pass=pandora</nowiki><nowiki>Insert non-formatted text here</nowiki>
  
====get module_name====
+
===get module_name===
 
Devuelve el nombre de un módulo dado su identificador.
 
Devuelve el nombre de un módulo dado su identificador.
  
Line 727: Line 695:
 
*id=&lt;id modulo&gt; (obligatorio)
 
*id=&lt;id modulo&gt; (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=module_name&id=1&apipass=1234&user=admin&pass=pandora
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=module_name&id=1&apipass=1234&user=admin&pass=pandora
 
</nowiki>
 
</nowiki>
  
====get alert_action_by_group====
+
===get alert_action_by_group===
 
Devuelve el total de ejecuciones de alertas con una determinada acción por grupo.
 
Devuelve el total de ejecuciones de alertas con una determinada acción por grupo.
  
Line 740: Line 708:
 
*id2=&lt;id acción&gt; (obligatorio)
 
*id2=&lt;id acción&gt; (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=alert_action_by_group&id=0&id2=3&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=alert_action_by_group&id=0&id2=3&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get alert_actions====
+
===get alert_actions===
 
Lista acciones de alertas
 
Lista acciones de alertas
  
Line 754: Line 722:
 
:*&lt;separator&gt; (opcional)
 
:*&lt;separator&gt; (opcional)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=alert_actions&apipass=1234&user=admin&pass=pandora&other=Create|&other_mode=url_encode_separator_|&return_type=json</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=alert_actions&apipass=1234&user=admin&pass=pandora&other=Create|&other_mode=url_encode_separator_|&return_type=json</nowiki>
  
====get alert_actions_meta====
+
===get alert_actions_meta===
 
 
 
{{metaconsola}}
 
{{metaconsola}}
 
Lista acciones de alertas de nodos desde la metaconsola.
 
Lista acciones de alertas de nodos desde la metaconsola.
Line 771: Line 738:
 
:*&lt;separator&gt; (opcional)
 
:*&lt;separator&gt; (opcional)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=alert_actions_meta&apipass=1234&user=admin&pass=pandora&other=nodo|Create|&other_mode=url_encode_separator_|&return_type=json</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=alert_actions_meta&apipass=1234&user=admin&pass=pandora&other=nodo|Create|&other_mode=url_encode_separator_|&return_type=json</nowiki>
  
====get all_alert_commands====
+
===get all_alert_commands===
 
Devuelve todos los comandos de alertas.
 
Devuelve todos los comandos de alertas.
  
Line 781: Line 748:
 
*op2=all_alert_commands (obligatorio)
 
*op2=all_alert_commands (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=all_alert_commands&return_type=csv&other=$&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=all_alert_commands&return_type=csv&other=$&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get event_info====
+
===get event_info===
 
Devuelve toda la información de un evento pasando el id de este evento.
 
Devuelve toda la información de un evento pasando el id de este evento.
  
Line 795: Line 762:
 
*id=&lt;id_evento&gt; (obligatorio)
 
*id=&lt;id_evento&gt; (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=event_info&id=80&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=event_info&id=80&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get tactical_view====
+
===get tactical_view===
 
Devuelve la siguiente lista de valores (que se puede ver en la página táctica de Pandora Console)
 
Devuelve la siguiente lista de valores (que se puede ver en la página táctica de Pandora Console)
 
* monitor_checks
 
* monitor_checks
Line 833: Line 800:
 
*op2=tactical_view (obligatorio)
 
*op2=tactical_view (obligatorio)
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=tactical_view&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=tactical_view&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get pandora_servers====
+
===get pandora_servers===
 
>= 5.0
 
>= 5.0
  
Line 847: Line 814:
 
*other=cvs_separator (opcional)
 
*other=cvs_separator (opcional)
  
=====Example=====
+
====Example====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=pandora_servers&return_type=csv&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=pandora_servers&return_type=csv&apipass=1234&user=admin&pass=pandora</nowiki>
  
Line 863: Line 830:
 
*fecha y hora de actualización (cadena legible por humanos)
 
*fecha y hora de actualización (cadena legible por humanos)
  
====get custom_field_id====
+
===get custom_field_id===
 
>= 5.0
 
>= 5.0
  
Line 874: Line 841:
 
:*&lt;name&gt; (obligatorio)
 
:*&lt;name&gt; (obligatorio)
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=custom_field_id&other=mycustomfield&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki><nowiki>Insert non-formatted text here</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=custom_field_id&other=mycustomfield&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki><nowiki>Insert non-formatted text here</nowiki>
  
====get gis_agent====
+
===get gis_agent===
 
>= 5.0
 
>= 5.0
  
Line 888: Line 854:
 
*id=<índice> (obligatorio) debe ser un índice de un agente.
 
*id=<índice> (obligatorio) debe ser un índice de un agente.
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
<nowiki>http://localhost/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=gis_agent&id=1</nowiki>
 
<nowiki>http://localhost/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=gis_agent&id=1</nowiki>
  
====get special_days====
+
===get special_days===
 
>= 5.1
 
>= 5.1
  
Line 903: Line 868:
 
*other=<csv separador> (opcional) CSV separador
 
*other=<csv separador> (opcional) CSV separador
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1111&user=admin&pass=pandora&op=get&op2=special_days</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1111&user=admin&pass=pandora&op=get&op2=special_days</nowiki>
  
====get module_properties====
+
===get module_properties===
 
>= 5.1SP2
 
>= 5.1SP2
  
Line 973: Line 937:
 
::::*module_warning_inverse  (solo versión 6.0SP1)
 
::::*module_warning_inverse  (solo versión 6.0SP1)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties&id=6233&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties&id=6233&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties&id=1103&return_type=csv&other=;|%20|module_id_agent_module,module_id_module_type,module_name,module_last_try,module_state&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties&id=1103&return_type=csv&other=;|%20|module_id_agent_module,module_id_module_type,module_name,module_last_try,module_state&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
 
</nowiki>
 
</nowiki>
  
====get module_properties_by_name====
+
===get module_properties_by_name===
 
>= 5.1SP2
 
>= 5.1SP2
  
Line 992: Line 955:
 
*other=&lt;string o parametros serializados&gt; (opcional) en este caso puede ser simplemente el separador o una lista de parametros en orden y separados con el caracter separador (el mismo que get_module_properties. para mas detalles, consulte el get_module_properties.
 
*other=&lt;string o parametros serializados&gt; (opcional) en este caso puede ser simplemente el separador o una lista de parametros en orden y separados con el caracter separador (el mismo que get_module_properties. para mas detalles, consulte el get_module_properties.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_name&id=my_agent&id2=my_module&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_name&id=my_agent&id2=my_module&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_name&id=my_agent&id2=my_module&return_type=csv&other=;|%20|module_id_agent_module,module_id_module_type,module_type,module_name,module_last_try,module_state&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_name&id=my_agent&id2=my_module&return_type=csv&other=;|%20|module_id_agent_module,module_id_module_type,module_type,module_name,module_last_try,module_state&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get module_properties_by_alias====
+
===get module_properties_by_alias===
 
>= 7.0NG
 
>= 7.0NG
  
Line 1,010: Line 972:
 
*other=&lt;string o parámetros serializados&gt; (opcional) en este caso puede ser simplemente el separador o una lista de parámetros en orden y separados con el carácter separador (el mismo que get_module_properties. para más detalles, consulte el get_module_properties.
 
*other=&lt;string o parámetros serializados&gt; (opcional) en este caso puede ser simplemente el separador o una lista de parámetros en orden y separados con el carácter separador (el mismo que get_module_properties. para más detalles, consulte el get_module_properties.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_alias&id=pandorafms&id2=Memory_Used&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_alias&id=pandorafms&id2=Memory_Used&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
 
</nowiki>
 
</nowiki>
  
====get module_graph====
+
===get module_graph===
 
>= 6.0
 
>= 6.0
  
Line 1,026: Line 987:
 
*other=<período en segundos> (opcional) por defecto 3600 (1 hora). Rango de tiempo en el que se recogerán datos desde la fecha de la petición hacia atrás.
 
*other=<período en segundos> (opcional) por defecto 3600 (1 hora). Rango de tiempo en el que se recogerán datos desde la fecha de la petición hacia atrás.
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=module_graph&id=5&other=3600%7C1&other_mode=url_encode_separator_%7C&apipass=1234&api=1&user=admin&pass=pandora
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=module_graph&id=5&other=3600%7C1&other_mode=url_encode_separator_%7C&apipass=1234&api=1&user=admin&pass=pandora
 
</nowiki>
 
</nowiki>
  
====get all_planned_downtimes====
+
===get all_planned_downtimes===
 
>= 5.1
 
>= 5.1
  
Line 1,043: Line 1,003:
  
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_planned_downtimes&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=json&apipass=1234&user=admin&pass=pandora
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_planned_downtimes&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=json&apipass=1234&user=admin&pass=pandora
 
</nowiki> <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_planned_downtimes&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=csv&apipass=1234&user=admin&pass=pandora</nowiki>
 
</nowiki> <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_planned_downtimes&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=csv&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get planned_downtimes_items====
+
===get planned_downtimes_items===
 
>= 5.1
 
>= 5.1
  
Line 1,059: Line 1,018:
  
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=planned_downtimes_items&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=json&apipass=1234&user=admin&pass=pandora
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=planned_downtimes_items&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=json&apipass=1234&user=admin&pass=pandora
 
</nowiki> <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=planned_downtimes_items&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=csv&apipass=1234&user=admin&pass=pandora
 
</nowiki> <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=planned_downtimes_items&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=csv&apipass=1234&user=admin&pass=pandora
 
</nowiki>
 
</nowiki>
  
====get id_group_agent_by_name====
+
===get id_group_agent_by_name===
 
>= 5.1
 
>= 5.1
  
Line 1,077: Line 1,035:
 
:* <nombre_agente>
 
:* <nombre_agente>
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=id_group_agent_by_name&other_mode=url_encode_separator_|&other=192.168.50.40
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=id_group_agent_by_name&other_mode=url_encode_separator_|&other=192.168.50.40
 
</nowiki>
 
</nowiki>
  
====get id_group_agent_by_alias====
+
===get id_group_agent_by_alias===
 
>= 7.0NG
 
>= 7.0NG
  
Line 1,093: Line 1,051:
 
:* <alias_agente>
 
:* <alias_agente>
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=id_group_agent_by_alias&other_mode=url_encode_separator_%7C&other=pandorafms
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=id_group_agent_by_alias&other_mode=url_encode_separator_%7C&other=pandorafms
 
</nowiki>
 
</nowiki>
  
====get group_agent_by_name====
+
===get group_agent_by_name===
 
>= 5.1
 
>= 5.1
  
Line 1,109: Line 1,067:
 
:* <nombre_agente>
 
:* <nombre_agente>
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_agent_by_name&other_mode=url_encode_separator_|&other=192.168.50.40
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_agent_by_name&other_mode=url_encode_separator_|&other=192.168.50.40
 
</nowiki>
 
</nowiki>
  
====get group_agent_by_alias====
+
===get group_agent_by_alias===
 
>= 7.0NG
 
>= 7.0NG
  
Line 1,125: Line 1,083:
 
:* <alias_agente>
 
:* <alias_agente>
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_agent_by_alias&other_mode=url_encode_separator_%7C&other=pandorafms
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_agent_by_alias&other_mode=url_encode_separator_%7C&other=pandorafms
 
</nowiki>
 
</nowiki>
  
====get group_id_by_name====
+
===get group_id_by_name===
 
>= 7.0NG
 
>= 7.0NG
  
Line 1,141: Line 1,099:
 
:* <group_name>
 
:* <group_name>
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_id_by_name&other=Servers</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_id_by_name&other=Servers</nowiki>
  
====get timezone====
+
===get timezone===
 
>= 7.0NG
 
>= 7.0NG
  
Line 1,154: Line 1,112:
 
* op2=timezone
 
* op2=timezone
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=timezone</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=timezone</nowiki>
  
====get cluster_status====
+
===get cluster_status===
 
>= 7.0
 
>= 7.0
  
Line 1,168: Line 1,126:
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_status&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_status&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get cluster_id_by_name====
+
===get cluster_id_by_name===
 
>= 7.0
 
>= 7.0
  
Line 1,179: Line 1,137:
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_id_by_name&id=paco&apipass=1234&user=admin&pass=pandora</nowiki>
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_id_by_name&id=paco&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get agents_id_name_by_cluster_id====
+
===get agents_id_name_by_cluster_id===
 
>= 7.0
 
>= 7.0
  
Line 1,190: Line 1,148:
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agents_id_name_by_cluster_id&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agents_id_name_by_cluster_id&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get agents_id_name_by_cluster_name====
+
===get agents_id_name_by_cluster_name===
 
>= 7.0
 
>= 7.0
  
Line 1,201: Line 1,159:
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agents_id_name_by_cluster_name&id=example&apipass=1234&user=admin&pass=pandora</nowiki>
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agents_id_name_by_cluster_name&id=example&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get modules_id_name_by_cluster_id====
+
===get modules_id_name_by_cluster_id===
 
>= 7.0
 
>= 7.0
  
Line 1,212: Line 1,170:
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=modules_id_name_by_cluster_id&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=modules_id_name_by_cluster_id&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get modules_id_name_by_cluster_name====
+
===get modules_id_name_by_cluster_name===
 
>= 7.0
 
>= 7.0
  
Line 1,223: Line 1,181:
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=modules_id_name_by_cluster_name&id=example&apipass=1234&user=admin&pass=pandora</nowiki>
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=modules_id_name_by_cluster_name&id=example&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get cluster_items====
+
===get cluster_items===
 
>= 7.0
 
>= 7.0
  
Line 1,238: Line 1,196:
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_items&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_items&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get policy====
+
===get policy===
 
>= 7.0NG. 725
 
>= 7.0NG. 725
  
Line 1,250: Line 1,208:
 
* return_type=(json, csv, string).
 
* return_type=(json, csv, string).
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
  
====get collections_policy====
+
===get collections_policy===
 
>= 7.0NG. 725
 
>= 7.0NG. 725
  
Line 1,265: Line 1,223:
 
* return_type=(json, csv, string).
 
* return_type=(json, csv, string).
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=collections_policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=collections_policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
  
====get plugins_policy====
+
===get plugins_policy===
 
>= 7.0NG. 725
 
>= 7.0NG. 725
  
Line 1,280: Line 1,238:
 
* return_type=(json, csv, string).
 
* return_type=(json, csv, string).
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=plugins_policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=plugins_policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
  
====get inventory_policy====
+
===get inventory_policy===
 
>= 7.0NG. 725
 
>= 7.0NG. 725
  
Line 1,295: Line 1,253:
 
* return_type=(json, csv, string).
 
* return_type=(json, csv, string).
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=inventory_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=inventory_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2</nowiki>
  
====get unlinking_policy====
+
===get unlinking_policy===
 
>= 7.0NG. 725
 
>= 7.0NG. 725
  
Line 1,310: Line 1,268:
 
* return_type=(json, csv, string).
 
* return_type=(json, csv, string).
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=unlinking_policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=unlinking_policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
  
====get alerts_policy====
+
===get alerts_policy===
 
>= 7.0NG. 725
 
>= 7.0NG. 725
  
Line 1,332: Line 1,290:
 
* return_type=(json, csv, string).
 
* return_type=(json, csv, string).
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id2=2.</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id2=2.</nowiki>
  
====get alerts_actions_policy====
+
===get alerts_actions_policy===
 
>= 7.0NG. 725
 
>= 7.0NG. 725
  
Line 1,351: Line 1,309:
 
* return_type=(json, csv, string).
 
* return_type=(json, csv, string).
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=alerts_actions_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=1&id2=3</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=alerts_actions_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=1&id2=3</nowiki>
  
====get agents_policy====
+
===get agents_policy===
 
>= 7.0NG. 725
 
>= 7.0NG. 725
  
Line 1,366: Line 1,324:
 
* return_type = (json, csv, string).
 
* return_type = (json, csv, string).
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=agents_policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=agents_policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
  
====get groups_policy====
+
===get groups_policy===
 
>= 7.0NG. 725
 
>= 7.0NG. 725
  
Line 1,381: Line 1,339:
 
* return_type = (json, csv, string).
 
* return_type = (json, csv, string).
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=groups_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=groups_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2</nowiki>
  
====get queue_policy====
+
===get queue_policy===
 
>= 7.0NG. 725
 
>= 7.0NG. 725
  
Line 1,396: Line 1,354:
 
* return_type = (json, csv, string).
 
* return_type = (json, csv, string).
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=queue_policy&apipass=1234&user=admin&pass=pandora&return_type=json</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=queue_policy&apipass=1234&user=admin&pass=pandora&return_type=json</nowiki>
  
====get traps====
+
===get traps===
 
>= 7.0NG. 728
 
>= 7.0NG. 728
  
Line 1,415: Line 1,373:
 
:* <oid_custom>
 
:* <oid_custom>
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>https://localhost/pandora_console/include/api.php?op=get&op2=traps&other=1537128000%7C9000%7C0%7C1%7C.1.2.3.6.4&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>https://localhost/pandora_console/include/api.php?op=get&op2=traps&other=1537128000%7C9000%7C0%7C1%7C.1.2.3.6.4&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get event_responses====
+
===get event_responses===
 
Devuelve la lista de respuesta de eventos a las que el usuario tiene acceso en Pandora FMS.
 
Devuelve la lista de respuesta de eventos a las que el usuario tiene acceso en Pandora FMS.
  
Line 1,426: Line 1,384:
 
*return_type=csv|json (obligatorio)
 
*return_type=csv|json (obligatorio)
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
Este ejemplo devolverá todas las respuestas de eventos del sistema en formato csv.
 
Este ejemplo devolverá todas las respuestas de eventos del sistema en formato csv.
  
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=event_responses&return_type=csv&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=event_responses&return_type=csv&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get users====
+
===get users===
 
Devuelve la lista de los usuario de Pandora FMS.
 
Devuelve la lista de los usuario de Pandora FMS.
  
Line 1,440: Line 1,397:
 
*return_type=csv|json (obligatorio)
 
*return_type=csv|json (obligatorio)
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
Este ejemplo devolverá todos usuario del sistema en formato csv.
 
Este ejemplo devolverá todos usuario del sistema en formato csv.
  
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=users&json&return_type=csv&other_mode=url_encode_separator_&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=users&json&return_type=csv&other_mode=url_encode_separator_&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get list all user====
+
===get list all user===
 
 
 
{{metaconsola}}
 
{{metaconsola}}
 
Listar todos los usuarios de Pandora FMS
 
Listar todos los usuarios de Pandora FMS
Line 1,456: Line 1,411:
 
*return_type=csv|json (obligatorio)
 
*return_type=csv|json (obligatorio)
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
Puede retornar Json o CSV, este retorno se indica mediante la URL
 
Puede retornar Json o CSV, este retorno se indica mediante la URL
 
solo se indica el tipo de retorno, no usa ninguna variable en específico
 
solo se indica el tipo de retorno, no usa ninguna variable en específico
Line 1,463: Line 1,417:
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=list_all_user&return_type=json&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=list_all_user&return_type=json&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get info user name====
+
===get info user name===
 
 
 
{{metaconsola}}
 
{{metaconsola}}
 
Lista la informacion de un usuario
 
Lista la informacion de un usuario
Line 1,474: Line 1,427:
 
*other=nombre de usuario(obligatorio)
 
*other=nombre de usuario(obligatorio)
  
=====Ejemplo=====
+
====Ejemplo====
 
Obtenemos toda la información de un usuario específico
 
Obtenemos toda la información de un usuario específico
 
Puede retornar Json o CSV, este retorno se indica mediante la URL
 
Puede retornar Json o CSV, este retorno se indica mediante la URL
Line 1,481: Line 1,434:
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=info_user_name&return_type=json&other=admin&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=info_user_name&return_type=json&other=admin&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get user_profiles_info====
+
===get user_profiles_info===
 
Devuelve la lista de los perfiles de usuario de Pandora FMS.
 
Devuelve la lista de los perfiles de usuario de Pandora FMS.
  
Line 1,489: Line 1,442:
 
*return_type=csv|json (obligatorio)
 
*return_type=csv|json (obligatorio)
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
Este ejemplo devolverá todos los perfiles de usuario del sistema en formato json.
 
Este ejemplo devolverá todos los perfiles de usuario del sistema en formato json.
  
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=user_profiles_info&return_type=json&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=user_profiles_info&return_type=json&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get migrate_agent====
+
===get migrate_agent===
 
>= 7.21 ONLY METACONSOLE
 
>= 7.21 ONLY METACONSOLE
  
Line 1,505: Line 1,457:
 
*return_type = string, json, etc
 
*return_type = string, json, etc
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=migrate_agent&apipass=1234&user=admin&pass=pandora&id=2&return_type=json</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=migrate_agent&apipass=1234&user=admin&pass=pandora&id=2&return_type=json</nowiki>
  
====get language====
+
===get language===
 
>= 7.0NG 730
 
>= 7.0NG 730
  
Line 1,519: Line 1,470:
 
* op2=language
 
* op2=language
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=language</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=language</nowiki>
  
====get session_timeout====
+
===get session_timeout===
 
>= 7.0NG 730
 
>= 7.0NG 730
  
Line 1,532: Line 1,483:
 
* op2=session_timeout
 
* op2=session_timeout
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=session_timeout</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=session_timeout</nowiki>
  
====get groups====
+
===get groups===
 
 
 
Retorna los grupos existentes.
 
Retorna los grupos existentes.
  
Line 1,548: Line 1,498:
 
:* <return_all_columns>: devuelve todas las columnas.
 
:* <return_all_columns>: devuelve todas las columnas.
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=groups&other=;%7C1%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=groups&other=;%7C1%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get filter user group====
+
===get filter user group===
 
 
 
{{metaconsola}}
 
{{metaconsola}}
 
Obtener grupos de usuario mediante filtrado.
 
Obtener grupos de usuario mediante filtrado.
Line 1,563: Line 1,512:
 
*other= id group(obligatorio)|Habilitado o no(Disabled)(obligatorio)
 
*other= id group(obligatorio)|Habilitado o no(Disabled)(obligatorio)
  
=====Ejemplo=====
+
====Ejemplo====
 
Puede retornar Json o CSV, este retorno se indica mediante la URL.
 
Puede retornar Json o CSV, este retorno se indica mediante la URL.
  
Line 1,570: Line 1,519:
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=filter_user_group&return_type=json&other=0|0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=filter_user_group&return_type=json&other=0|0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get inventory_modules====
+
===get inventory_modules===
 
Devuelve la lista de los módulos de inventario de Pandora FMS.
 
Devuelve la lista de los módulos de inventario de Pandora FMS.
  
Line 1,578: Line 1,527:
 
*return_type=csv|json (obligatorio)
 
*return_type=csv|json (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
Este ejemplo devolverá información de todos los de inventario del sistema en formato json.
 
Este ejemplo devolverá información de todos los de inventario del sistema en formato json.
  
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=inventory_modules&return_type=json&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=inventory_modules&return_type=json&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get list_collections====
+
===get list_collections===
 
Devuelve la lista de todas las colecciones en Pandora FMS.
 
Devuelve la lista de todas las colecciones en Pandora FMS.
  
Line 1,591: Line 1,539:
 
*op2=list_collections (obligatorio)
 
*op2=list_collections (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
Este ejemplo devolverá información de todos las colecciones en formato json.
 
Este ejemplo devolverá información de todos las colecciones en formato json.
  
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=list_collections&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=list_collections&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get list_collection_files====
+
===get list_collection_files===
 
Devuelve la lista de todos los ficheros de una colección. Si no se le pasa id de colección, devolverá todos los ficheros de todas las colecciones.
 
Devuelve la lista de todos los ficheros de una colección. Si no se le pasa id de colección, devolverá todos los ficheros de todas las colecciones.
  
Line 1,605: Line 1,552:
 
*id=id_collection
 
*id=id_collection
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
Este ejemplo devolverá los nombres de todos los ficheros de una colección en formato json.
 
Este ejemplo devolverá los nombres de todos los ficheros de una colección en formato json.
  
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=list_collection_files&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=list_collection_files&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
  
===SET===
+
==SET==
 
 
 
Envia los datos.
 
Envia los datos.
  
====set new_agent====
+
===set new_agent===
 
Crea un nuevo agente con los datos pasados como parámetros.
 
Crea un nuevo agente con los datos pasados como parámetros.
  
Line 1,637: Line 1,582:
 
:*&lt;alias_as_name&gt;
 
:*&lt;alias_as_name&gt;
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_agent&other=agente_alias%7C1.1.1.1%7C0%7C4%7C0%7C0%7C300%7C10%7Cpandorafms%7C8%7C10%7C%7Cla%20descripcion%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_agent&other=agente_alias%7C1.1.1.1%7C0%7C4%7C0%7C0%7C300%7C10%7Cpandorafms%7C8%7C10%7C%7Cla%20descripcion%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
 
*Nota: Si ''alias_as_name'' es un 1, el nombre del agente será igual al alias. Si es un 0, el nombre del agente se generará automáticamente.
 
*Nota: Si ''alias_as_name'' es un 1, el nombre del agente será igual al alias. Si es un 0, el nombre del agente se generará automáticamente.
  
====set update_agent====
+
===set update_agent===
 
Actualiza el agente con los datos pasados como parámetros.
 
Actualiza el agente con los datos pasados como parámetros.
  
Line 1,665: Line 1,609:
 
:*&lt;description&gt;
 
:*&lt;description&gt;
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?id=5&op=set&op2=update_agent&other=agente_nombre|1.1.1.1|0|4|0|0|30|8|localhost.localdomain||0|0|la%20descripcion&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?id=5&op=set&op2=update_agent&other=agente_nombre|1.1.1.1|0|4|0|0|30|8|localhost.localdomain||0|0|la%20descripcion&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set delete_agent====
+
===set delete_agent===
 
 
 
Elimina un agente pasando el nombre como parámetro.
 
Elimina un agente pasando el nombre como parámetro.
  
Line 1,678: Line 1,620:
 
*id=&lt;nombre_agente&gt; (obligatorio) debe ser un nombre agente.
 
*id=&lt;nombre_agente&gt; (obligatorio) debe ser un nombre agente.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_agent&id=agente_erroneo&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_agent&id=agente_erroneo&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set create_module_template====
+
===set create_module_template===
 
 
 
Crea una alerta a partir de la plantilla pasada como id, en un módulo elegido por id de módulo y id de agente que estarán en other.
 
Crea una alerta a partir de la plantilla pasada como id, en un módulo elegido por id de módulo y id de agente que estarán en other.
  
Line 1,692: Line 1,632:
 
*other=&lt;id_modulo&gt;|&lt;id_agente&gt;
 
*other=&lt;id_modulo&gt;|&lt;id_agente&gt;
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_module_template&id=1&other=1|10&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_module_template&id=1&other=1|10&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set apply_module_template====
+
===set apply_module_template===
 
 
 
Aplicar una plantilla de módulos a un agente..
 
Aplicar una plantilla de módulos a un agente..
  
Line 1,708: Line 1,646:
 
*id2=&lt;id_agente&gt; (obligatorio) id del agente en el que se crearán los módulos.
 
*id2=&lt;id_agente&gt; (obligatorio) id del agente en el que se crearán los módulos.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_module_template&id=2&id2=2&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_module_template&id=2&id2=2&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set create_network_module====
+
===set create_network_module===
 
Crea un módulo de red con los datos pasados como parámetros.
 
Crea un módulo de red con los datos pasados como parámetros.
  
Line 1,752: Line 1,689:
 
:*&lt;ff_type&gt; (solo versión 7.34)
 
:*&lt;ff_type&gt; (solo versión 7.34)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_network_module&id=example&other=prueba|0|7|1|10|15|0|16|18|0|15|0|127.0.0.1|0||0|180|0|0|0|0|latency%20ping&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_network_module&id=example&other=prueba|0|7|1|10|15|0|16|18|0|15|0|127.0.0.1|0||0|180|0|0|0|0|latency%20ping&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set create_plugin_module====
+
===set create_plugin_module===
 
Crea un módulo de tipo plugin con los datos pasados como parámetros.
 
Crea un módulo de tipo plugin con los datos pasados como parámetros.
  
Line 1,797: Line 1,733:
 
**''"value"'': Valor del macro.
 
**''"value"'': Valor del macro.
 
**''"hide"'': Poner a "1" para ocultar el valor del macro (útil para almacenar contraseñas).
 
**''"hide"'': Poner a "1" para ocultar el valor del macro (útil para almacenar contraseñas).
=====Ejemplo=====
+
====Ejemplo====
 
  {
 
  {
 
   "1": {
 
   "1": {
Line 1,823: Line 1,759:
 
:*&lt;ff_type&gt; (solo versión 734)
 
:*&lt;ff_type&gt; (solo versión 734)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_plugin_module&id=example&other=prueba|0|1|2|0|0||0|0||0|0|127.0.0.1|0||0|300|0|0|0|0|plugin%20module%20from%20api|4|2|admin|pass|-p%20max&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_plugin_module&id=example&other=prueba|0|1|2|0|0||0|0||0|0|127.0.0.1|0||0|300|0|0|0|0|plugin%20module%20from%20api|4|2|admin|pass|-p%20max&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set create_data_module====
+
===set create_data_module===
 
 
 
Crea un módulo con los parámetros pasados.
 
Crea un módulo con los parámetros pasados.
  
Line 1,866: Line 1,800:
 
:*&lt;ff_type&gt; (solo versión 734)
 
:*&lt;ff_type&gt; (solo versión 734)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_data_module&id=example&other=prueba|0|1|data%20module%20from%20api|1|10|20|10.50|180|10|15||16|20||0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_data_module&id=example&other=prueba|0|1|data%20module%20from%20api|1|10|20|10.50|180|10|15||16|20||0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set create_SNMP_module====
+
===set create_SNMP_module===
 
 
 
Crea un módulo SNMP.
 
Crea un módulo SNMP.
  
Line 1,915: Line 1,847:
 
:*&lt;ff_type&gt; (solo versión 734)
 
:*&lt;ff_type&gt; (solo versión 734)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
Ejemplo 1 (snmp v: 3, snmp3_priv_method: AES, snmp3_priv_pass: example_priv_passw, snmp3_sec_level: authNoPriv, snmp3_auth_method:MD5, snmp3_auth_user: pepito_user, snmp3_auth_pass: example_priv_passw)
 
Ejemplo 1 (snmp v: 3, snmp3_priv_method: AES, snmp3_priv_pass: example_priv_passw, snmp3_sec_level: authNoPriv, snmp3_auth_method:MD5, snmp3_auth_user: pepito_user, snmp3_auth_pass: example_priv_passw)
  
Line 1,925: Line 1,856:
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_snmp_module&id=pepito1&other=prueba2|0|15|1|10|15||16|18||15|0|127.0.0.1|60|1|public|.1.3.6.1.2.1.1.1.0|180|0|0|0|0|SNMP module from API&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_snmp_module&id=pepito1&other=prueba2|0|15|1|10|15||16|18||15|0|127.0.0.1|60|1|public|.1.3.6.1.2.1.1.1.0|180|0|0|0|0|SNMP module from API&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set update_network_module====
+
===set update_network_module===
 
 
 
Actualiza la configuración de un módulo de red.
 
Actualiza la configuración de un módulo de red.
  
Line 1,965: Line 1,895:
 
:*&lt;ff_type&gt; (solo versión 733)
 
:*&lt;ff_type&gt; (solo versión 733)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_network_module&id=3431&other=44|0|6|2|10|15||16|18||7|0|127.0.0.1|0||0|300|30.00|0|0|0|latency%20ping%20modified%20by%20the%20Api&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_network_module&id=3431&other=44|0|6|2|10|15||16|18||7|0|127.0.0.1|0||0|300|30.00|0|0|0|latency%20ping%20modified%20by%20the%20Api&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set update_plugin_module====
+
===set update_plugin_module===
 
 
 
Actualiza la configuración de un módulo plugin.
 
Actualiza la configuración de un módulo plugin.
  
Line 2,009: Line 1,937:
 
**''"help"'': Descripción del macro.
 
**''"help"'': Descripción del macro.
 
**''"value"'': Valor del macro.
 
**''"value"'': Valor del macro.
=====Ejemplo=====
+
====Ejemplo====
 
  {
 
  {
 
   "1": {
 
   "1": {
Line 2,033: Line 1,961:
 
:*&lt;ff_type&gt; (solo versión 734)
 
:*&lt;ff_type&gt; (solo versión 734)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_plugin_module&id=2343&other=44|0|2|0|0||0|0||0|0|127.0.0.1|0||0|300|0|0|0|0|plugin%20module%20from%20api|2|admin|pass|-p%20max&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_plugin_module&id=2343&other=44|0|2|0|0||0|0||0|0|127.0.0.1|0||0|300|0|0|0|0|plugin%20module%20from%20api|2|admin|pass|-p%20max&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set update_data_module====
+
===set update_data_module===
 
 
 
<br>
 
<br>
 
{{warning|Con esta llamada se puede añadir datos al módulo en la base de datos, pero no se puede modificar el fichero de configuración de los agentes asociados al módulo}}
 
{{warning|Con esta llamada se puede añadir datos al módulo en la base de datos, pero no se puede modificar el fichero de configuración de los agentes asociados al módulo}}
Line 2,082: Line 2,008:
 
:*&lt;ff_type&gt; (solo versión 734)
 
:*&lt;ff_type&gt; (solo versión 734)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_data_module&id=23234&other=44|0|data%20module%20modified%20from%20API|6|0|0|50.00|300|10|15||16|18||0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_data_module&id=23234&other=44|0|data%20module%20modified%20from%20API|6|0|0|50.00|300|10|15||16|18||0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set update_data_module_policy====
+
===set update_data_module_policy===
 
 
 
 
 
Actualiza el módulo de datos de una política y devuelve el id del nuevo módulo.
 
Actualiza el módulo de datos de una política y devuelve el id del nuevo módulo.
  
Line 2,113: Line 2,036:
 
:*&lt;module_macros&gt; (solo versión 5) Los valores deben estar en formato JSON codificado en base 64. El formato de los datos del documento JSON debe ser ''"<nombre de macro>": "<valor de macro>"''.
 
:*&lt;module_macros&gt; (solo versión 5) Los valores deben estar en formato JSON codificado en base 64. El formato de los datos del documento JSON debe ser ''"<nombre de macro>": "<valor de macro>"''.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_data_module_policy&id=1&other=10~data%20module%20updated%20by%20Api~2~0~0~50.00~10~20~180~~21~35~~1~module_begin%0dmodule_name%20pandora_process%0dmodule_type%20generic_data%0dmodule_exec%20ps%20aux%20|%20grep%20pandora%20|%20wc%20-l%0dmodule_end&other_mode=url_encode_separator_</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_data_module_policy&id=1&other=10~data%20module%20updated%20by%20Api~2~0~0~50.00~10~20~180~~21~35~~1~module_begin%0dmodule_name%20pandora_process%0dmodule_type%20generic_data%0dmodule_exec%20ps%20aux%20|%20grep%20pandora%20|%20wc%20-l%0dmodule_end&other_mode=url_encode_separator_</nowiki>
  
====set update_SNMP_module====
+
===set update_SNMP_module===
 
 
 
Actualiza un módulo SNMP.
 
Actualiza un módulo SNMP.
  
Line 2,162: Line 2,083:
 
:*&lt;ff_type&gt; (solo versión 734)
 
:*&lt;ff_type&gt; (solo versión 734)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
Example (snmp v: 3, snmp3_priv_method: AES, snmp3_priv_pass: example_priv_passw, snmp3_sec_level: authNoPriv, snmp3_auth_method:MD5, snmp3_auth_user: pepito_user, snmp3_auth_pass: example_priv_passw)
 
Example (snmp v: 3, snmp3_priv_method: AES, snmp3_priv_pass: example_priv_passw, snmp3_sec_level: authNoPriv, snmp3_auth_method:MD5, snmp3_auth_user: pepito_user, snmp3_auth_pass: example_priv_passw)
  
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_snmp_module&id=33432&other=44|0|6|20|25||26|30||15|1|127.0.0.1|60|3|public|.1.3.6.1.2.1.1.1.0|180|50.00|10|60|0|SNMP%20module%20modified%20by%20API|AES|example_priv_passw|authNoPriv|MD5|example_user|example_auth_passw&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_snmp_module&id=33432&other=44|0|6|20|25||26|30||15|1|127.0.0.1|60|3|public|.1.3.6.1.2.1.1.1.0|180|50.00|10|60|0|SNMP%20module%20modified%20by%20API|AES|example_priv_passw|authNoPriv|MD5|example_user|example_auth_passw&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set apply_policy====
+
===set apply_policy===
 
Aplica la política, pasada por id, en uno o varios agentes.
 
Aplica la política, pasada por id, en uno o varios agentes.
  
Line 2,180: Line 2,100:
 
:*&lt;id_servidor&gt; (obligatorio en caso de usar Metaconsola) Id del servidor sobre el que se aplicará la política.  
 
:*&lt;id_servidor&gt; (obligatorio en caso de usar Metaconsola) Id del servidor sobre el que se aplicará la política.  
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://192.168.70.102/pandora_console/include/api.php?op=set&op2=apply_policy&id=22&id2=3e&other=0|1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://192.168.70.102/pandora_console/include/api.php?op=set&op2=apply_policy&id=22&id2=3e&other=0|1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set apply_all_policies====
+
===set apply_all_policies===
 
 
 
Aplica todas las políticas que contiene Pandora.
 
Aplica todas las políticas que contiene Pandora.
  
Line 2,192: Line 2,110:
 
*op2=apply_all_policies (obligatorio)
 
*op2=apply_all_policies (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_all_policies&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_all_policies&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set add_network_module_policy====
+
===set add_network_module_policy===
 
 
 
Añade un módulo de red en la política pasada por id en el parámetro.
 
Añade un módulo de red en la política pasada por id en el parámetro.
  
Line 2,234: Line 2,150:
 
:*&lt;ff_type&gt; (solo versión 734)
 
:*&lt;ff_type&gt; (solo versión 734)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_network_module_policy&id=1&other=network_module_policy_example_name|6|network%20module%20created%20by%20Api|2|0|0|50.00|180|10|20||21|35||1|15|0|66|||0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_network_module_policy&id=1&other=network_module_policy_example_name|6|network%20module%20created%20by%20Api|2|0|0|50.00|180|10|20||21|35||1|15|0|66|||0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set add_plugin_module_policy====
+
===set add_plugin_module_policy===
 
 
 
Añade un módulo de plugin en la política pasada por id en el parámetro.
 
Añade un módulo de plugin en la política pasada por id en el parámetro.
  
Line 2,278: Line 2,192:
 
**''"help"'': Descripción del macro.
 
**''"help"'': Descripción del macro.
 
**''"value"'': Valor del macro.
 
**''"value"'': Valor del macro.
=====Ejemplo=====
+
====Ejemplo====
 
  {
 
  {
 
   "1": {
 
   "1": {
Line 2,300: Line 2,214:
 
:*&lt;ff_type&gt; (solo versión 734)
 
:*&lt;ff_type&gt; (solo versión 734)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_plugin_module_policy&id=1&other=example%20plugin%20module%20name|0|1|2|0|0||0|0||15|0|66|||300|50.00|0|0|0|plugin%20module%20from%20api|2|admin|pass|-p%20max&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_plugin_module_policy&id=1&other=example%20plugin%20module%20name|0|1|2|0|0||0|0||15|0|66|||300|50.00|0|0|0|plugin%20module%20from%20api|2|admin|pass|-p%20max&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set add_data_module_policy====
+
===set add_data_module_policy===
 
 
 
Añade un módulo local en la política pasada por id en el parámetro.
 
Añade un módulo local en la política pasada por id en el parámetro.
  
Line 2,339: Line 2,251:
 
:*&lt;ff_type&gt; (solo versión 734)
 
:*&lt;ff_type&gt; (solo versión 734)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_data_module_policy&id=1&other=data_module_policy_example_name~2~data%20module%20created%20by%20Api~2~0~0~50.00~10~20~180~~21~35~~1~module_begin%0dmodule_name%20pandora_process%0dmodule_type%20generic_data%0dmodule_exec%20ps%20aux%20|%20grep%20pandora%20|%20wc%20-l%0dmodule_end&other_mode=url_encode_separator_~&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_data_module_policy&id=1&other=data_module_policy_example_name~2~data%20module%20created%20by%20Api~2~0~0~50.00~10~20~180~~21~35~~1~module_begin%0dmodule_name%20pandora_process%0dmodule_type%20generic_data%0dmodule_exec%20ps%20aux%20|%20grep%20pandora%20|%20wc%20-l%0dmodule_end&other_mode=url_encode_separator_~&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set add_SNMP_module_policy====
+
===set add_SNMP_module_policy===
 
 
 
Añade un módulo SNMP en la política pasada por id en el parámetro.
 
Añade un módulo SNMP en la política pasada por id en el parámetro.
  
Line 2,387: Line 2,297:
 
:*&lt;ff_type&gt; (solo versión 734)
 
:*&lt;ff_type&gt; (solo versión 734)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_snmp_module_policy&id=1&other=example%20SNMP%20module%20name|0|15|2|0|0||0|0||15|1|66|3|public|.1.3.6.1.2.1.1.1.0|180|50.00|10|60|0|SNMP%20module%20modified%20by%20API|AES|example_priv_passw|authNoPriv|MD5|example_user|example_auth_passw&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_snmp_module_policy&id=1&other=example%20SNMP%20module%20name|0|15|2|0|0||0|0||15|1|66|3|public|.1.3.6.1.2.1.1.1.0|180|50.00|10|60|0|SNMP%20module%20modified%20by%20API|AES|example_priv_passw|authNoPriv|MD5|example_user|example_auth_passw&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set add_agent_policy_by_id====
+
===set add_agent_policy_by_id===
 
 
 
Añade un agente en una política utilizando el ID de agente.
 
Añade un agente en una política utilizando el ID de agente.
  
Line 2,403: Line 2,311:
 
:*&lt;id_node&gt; (obligatorio en caso de usar Metaconsola) ID del nodo al que pertenece el agente que deseamos añadir a la política.
 
:*&lt;id_node&gt; (obligatorio en caso de usar Metaconsola) ID del nodo al que pertenece el agente que deseamos añadir a la política.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
* Nodo:
 
* Nodo:
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_id&id=2&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_id&id=2&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
Line 2,411: Line 2,318:
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_id&id=2&other=1%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_id&id=2&other=1%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set add_agent_policy_by_name====
+
===set add_agent_policy_by_name===
 
 
 
Añade un agente en una política utilizando el nombre de agente.
 
Añade un agente en una política utilizando el nombre de agente.
  
Line 2,422: Line 2,328:
 
:*&lt;agent_name&gt;
 
:*&lt;agent_name&gt;
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_name&id=4&other=e76774025b24057cc71df514f27027c43484c3af766ed40f259a86a4fd568f9d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_name&id=4&other=e76774025b24057cc71df514f27027c43484c3af766ed40f259a86a4fd568f9d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set remove_agent_from_policy_by_id====
+
===set remove_agent_from_policy_by_id===
 
 
 
Elimina un agente de una política utilizando el ID de agente.
 
Elimina un agente de una política utilizando el ID de agente.
  
Line 2,438: Line 2,342:
 
:*&lt;id_node&gt; (obligatorio en caso de usar Metaconsola) ID del nodo al que pertenece el agente que deseamos eliminar de la política.
 
:*&lt;id_node&gt; (obligatorio en caso de usar Metaconsola) ID del nodo al que pertenece el agente que deseamos eliminar de la política.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
* Nodo:
 
* Nodo:
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_id&id=2&other=2&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_id&id=2&other=2&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
Line 2,446: Line 2,349:
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_id&id=4&other=1%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_id&id=4&other=1%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set remove_agent_from_policy_by_name====
+
===set remove_agent_from_policy_by_name===
 
 
 
Elimina un agente de una política utilizando el nombre de agente.
 
Elimina un agente de una política utilizando el nombre de agente.
  
Line 2,457: Line 2,359:
 
:*&lt;agent_name&gt;
 
:*&lt;agent_name&gt;
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_name&id=4&other=e76774025b24057cc71df514f27027c43484c3af766ed40f259a86a4fd568f9d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_name&id=4&other=e76774025b24057cc71df514f27027c43484c3af766ed40f259a86a4fd568f9d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set new_network_component====
+
===set new_network_component===
 
 
 
Crea un nuevo componente de red.
 
Crea un nuevo componente de red.
  
Line 2,496: Line 2,396:
  
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_network_component&id=example_network_component_name&other=7|network%20component%20created%20by%20Api|300|30|10|public|3||1|10|20|str|21|30|str1|10|50.00|12&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_network_component&id=example_network_component_name&other=7|network%20component%20created%20by%20Api|300|30|10|public|3||1|10|20|str|21|30|str1|10|50.00|12&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set new_plugin_component====
+
===set new_plugin_component===
 
 
 
Crea un nuevo componente de plugin.
 
Crea un nuevo componente de plugin.
  
Line 2,535: Line 2,433:
 
:*&lt;ff_type&gt; (solo versión 734)
 
:*&lt;ff_type&gt; (solo versión 734)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_plugin_component&id=example_plugin_component_name&other=2|plugin%20component%20created%20by%20Api|300|30|10|66|3|2|example_user|example_pass|-p%20max||1|10|20|str|21|30|str1|10|50.00|12&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_plugin_component&id=example_plugin_component_name&other=2|plugin%20component%20created%20by%20Api|300|30|10|66|3|2|example_user|example_pass|-p%20max||1|10|20|str|21|30|str1|10|50.00|12&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set new_snmp_component====
+
===set new_snmp_component===
 
 
 
Crea un nuevo componente de SNMP.
 
Crea un nuevo componente de SNMP.
  
Line 2,583: Line 2,479:
  
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_snmp_component&id=example_snmp_component_name&other=16|SNMP%20component%20created%20by%20Api|300|30|10|3||1|10|20|str|21|30|str1|15|50.00|3|.1.3.6.1.2.1.2.2.1.8.2|public|example_auth_user|example_auth_pass|66|AES|example_priv_pass|MD5|authNoPriv|12&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_snmp_component&id=example_snmp_component_name&other=16|SNMP%20component%20created%20by%20Api|300|30|10|3||1|10|20|str|21|30|str1|15|50.00|3|.1.3.6.1.2.1.2.2.1.8.2|public|example_auth_user|example_auth_pass|66|AES|example_priv_pass|MD5|authNoPriv|12&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set new_local_component====
+
===set new_local_component===
 
 
 
Crea un nuevo componente local.
 
Crea un nuevo componente local.
  
Line 2,609: Line 2,503:
 
:*&lt;ff_type&gt; (solo versión 734)
 
:*&lt;ff_type&gt; (solo versión 734)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_local_component&id=example_local_component_name&other=local%20component%20created%20by%20Api~5~12~module_begin%0dmodule_name%20example_local_component_name%0dmodule_type%20generic_data%0dmodule_exec%20ps%20|%20grep%20pid%20|%20wc%20-l%0dmodule_interval%202%0dmodule_end&other_mode=url_encode_separator_~&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_local_component&id=example_local_component_name&other=local%20component%20created%20by%20Api~5~12~module_begin%0dmodule_name%20example_local_component_name%0dmodule_type%20generic_data%0dmodule_exec%20ps%20|%20grep%20pid%20|%20wc%20-l%0dmodule_interval%202%0dmodule_end&other_mode=url_encode_separator_~&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set create_alert_template====
+
===set create_alert_template===
 
 
 
Crea una plantilla de alerta.
 
Crea una plantilla de alerta.
  
Line 2,651: Line 2,543:
 
:*&lt;id_group&gt;
 
:*&lt;id_group&gt;
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
Ejemplo 1 (condition: regexp =~ /pp/, action: Mail to XXX, max_alert: 10, min_alert: 0, priority: WARNING, group: databases):
 
Ejemplo 1 (condition: regexp =~ /pp/, action: Mail to XXX, max_alert: 10, min_alert: 0, priority: WARNING, group: databases):
  
Line 2,661: Line 2,552:
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_alert_template&id=template_min_max&other=max_min|template%20based%20in%20range|NULL||||||10|5||||00:00:00|15:00:00|||||||||||4|2&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_alert_template&id=template_min_max&other=max_min|template%20based%20in%20range|NULL||||||10|5||||00:00:00|15:00:00|||||||||||4|2&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set update_alert_template====
+
===set update_alert_template===
 
 
 
Actualiza una plantilla de alerta.
 
Actualiza una plantilla de alerta.
  
Line 2,700: Line 2,590:
 
:*&lt;id_group&gt;
 
:*&lt;id_group&gt;
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_alert_template&id=38&other=example_template_with_changed_name|onchange|changing%20from%20min_max%20to%20onchange||||||1||||5|1|||1|1|0|1|1|0|0|1|field%20recovery%20example%201|field%20recovery%20example%202|1|8&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_alert_template&id=38&other=example_template_with_changed_name|onchange|changing%20from%20min_max%20to%20onchange||||||1||||5|1|||1|1|0|1|1|0|0|1|field%20recovery%20example%201|field%20recovery%20example%202|1|8&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set delete_alert_template====
+
===set delete_alert_template===
 
 
 
Borra una plantilla de alerta y todas las alertas definidas por ella.
 
Borra una plantilla de alerta y todas las alertas definidas por ella.
  
Line 2,714: Line 2,602:
 
*id=&lt;id_template&gt; (obligatorio) debe ser un id de template.
 
*id=&lt;id_template&gt; (obligatorio) debe ser un id de template.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_alert_template&id=38&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_alert_template&id=38&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set delete_module_template====
+
===set delete_module_template===
 
 
 
Borra una plantilla de módulos.
 
Borra una plantilla de módulos.
  
Line 2,728: Line 2,614:
 
*id=&lt;id_alert_template_module&gt; (obligatorio) debe ser un id de alert_template_module.
 
*id=&lt;id_alert_template_module&gt; (obligatorio) debe ser un id de alert_template_module.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module_template&id=38&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module_template&id=38&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set delete_module_template_by_names====
+
===set delete_module_template_by_names===
 
 
 
Borra una plantilla de módulos.
 
Borra una plantilla de módulos.
  
Line 2,745: Line 2,629:
 
:*&lt;nombre modulo&gt; (obligatorio)
 
:*&lt;nombre modulo&gt; (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module_template_by_names&id=sample-agent&id2=test&other=memfree&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module_template_by_names&id=sample-agent&id2=test&other=memfree&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set stop_downtime====
+
===set stop_downtime===
 
 
 
Para una parada planificada.
 
Para una parada planificada.
  
Line 2,759: Line 2,641:
 
*id=&lt;id_downtime&gt; (obligatorio) debe ser un id downtime.
 
*id=&lt;id_downtime&gt; (obligatorio) debe ser un id downtime.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=stop_downtime&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=stop_downtime&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
  
====Set new_user====
+
===Set new_user===
 
 
 
Crea un nuevo usuario en Pandora FMS.
 
Crea un nuevo usuario en Pandora FMS.
  
Line 2,787: Line 2,667:
  
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_user&id=md&other=fullname|lastname|middlename|password|[email protected]|111|es|descripcion|30|event_filter|section|-1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_user&id=md&other=fullname|lastname|middlename|password|[email protected]|111|es|descripcion|30|event_filter|section|-1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====Set update_user====
+
===Set update_user===
 
 
 
Actualiza un usuario seleccionado por el id en parámetro id.
 
Actualiza un usuario seleccionado por el id en parámetro id.
  
Line 2,813: Line 2,691:
 
:*&lt;flash_chart&gt;
 
:*&lt;flash_chart&gt;
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_user&id=example_user_name&other=example_fullname||example_lastname||example_new_passwd|example_email||example_language|example%20comment|1|30|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_user&id=example_user_name&other=example_fullname||example_lastname||example_new_passwd|example_email||example_language|example%20comment|1|30|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set delete_user====
+
===set delete_user===
 
 
 
Borra un usuario seleccionado.
 
Borra un usuario seleccionado.
  
Line 2,826: Line 2,702:
 
*id=&lt;nombre_usuario&gt; (obligatorio) debe ser un nombre usuario.
 
*id=&lt;nombre_usuario&gt; (obligatorio) debe ser un nombre usuario.
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_user&id=md&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_user&id=md&apipass=1234&user=admin&pass=pandora</nowiki>
  
====Set delete_user_permissions====
+
===Set delete_user_permissions===
 
<br>
 
<br>
 
{{metaconsola}}
 
{{metaconsola}}
Line 2,841: Line 2,717:
 
*Other = id profile(obligatorio)
 
*Other = id profile(obligatorio)
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_user_permission&return_type=json&other=2&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_user_permission&return_type=json&other=2&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
Line 2,848: Line 2,724:
 
Puede retornar Json o CSV, este retorno se indica mediante la URL.
 
Puede retornar Json o CSV, este retorno se indica mediante la URL.
  
====Set add_permission_user_group====
+
===Set add_permission_user_group===
 
<br>
 
<br>
 
{{metaconsola}}
 
{{metaconsola}}
Line 2,860: Line 2,736:
 
* Other = user id(obligatorio)|group_id(obligatorio)|profile id(obligatorio)|No hierarchy(opcional)| permissions id(opcional)
 
* Other = user id(obligatorio)|group_id(obligatorio)|profile id(obligatorio)|No hierarchy(opcional)| permissions id(opcional)
  
=====Ejemplo=====
+
====Ejemplo====
 
Puede retornar Json o CSV, este retorno se indica mediante la URL.
 
Puede retornar Json o CSV, este retorno se indica mediante la URL.
 
{{Warning|no_hierarchy puede estar vacío, si es así toma el valor 0.}}
 
{{Warning|no_hierarchy puede estar vacío, si es así toma el valor 0.}}
Line 2,868: Line 2,744:
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=add_permission_user_to_group&return_type=json&other=admin|0|1|1||&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=add_permission_user_to_group&return_type=json&other=admin|0|1|1||&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set enable_disable_user====
+
===set enable_disable_user===
 
 
 
Activa un usuario desactivado.
 
Activa un usuario desactivado.
  
Line 2,877: Line 2,752:
 
*id=&lt;nombre_usuario&gt; (obligatorio) debe ser un nombre usuario.
 
*id=&lt;nombre_usuario&gt; (obligatorio) debe ser un nombre usuario.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
Ejemplo 1 (Disable user 'example_name')  
 
Ejemplo 1 (Disable user 'example_name')  
  
Line 2,887: Line 2,761:
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_user&id=example_name&other=1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_user&id=example_name&other=1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set meta_synch_user====
+
===set meta_synch_user===
 
 
 
{{metaconsola}}
 
{{metaconsola}}
 
Sincroniza usuarios de la metaconsola con el nodo
 
Sincroniza usuarios de la metaconsola con el nodo
Line 2,904: Line 2,777:
 
:*&lt;create_groups(1-0)&gt; (opcional)
 
:*&lt;create_groups(1-0)&gt; (opcional)
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=meta_synch_user&apipass=1234&user=admin&pass=pandora&other=name1,name2|nodo1|0|||&other_mode=url_encode_separator_|</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=meta_synch_user&apipass=1234&user=admin&pass=pandora&other=name1,name2|nodo1|0|||&other_mode=url_encode_separator_|</nowiki>
  
====set create_group====
+
===set create_group===
 
 
 
Crea un nuevo grupo.
 
Crea un nuevo grupo.
  
Line 2,927: Line 2,798:
 
:*&lt;otra informacion&gt; (opcional)
 
:*&lt;otra informacion&gt; (opcional)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
Ejemplo 1 (con grupo padre: Servers)  
 
Ejemplo 1 (con grupo padre: Servers)  
 
   
 
   
Line 2,937: Line 2,807:
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_group&id=example_group_name2&other=computer|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_group&id=example_group_name2&other=computer|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set update_group====
+
===set update_group===
 
 
 
Actualiza el grupo con los datos pasados como parámetros.
 
Actualiza el grupo con los datos pasados como parámetros.
  
Line 2,957: Line 2,826:
 
:*&lt;otra informacion&gt;
 
:*&lt;otra informacion&gt;
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_group&id=example_group_id&other=New%20Name|application|2|new%20description|1|0|custom%20id||&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_group&id=example_group_id&other=New%20Name|application|2|new%20description|1|0|custom%20id||&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set delete_group====
+
===set delete_group===
 
 
 
Eliminar un grupo
 
Eliminar un grupo
  
Line 2,970: Line 2,837:
 
*id=&lt;group_id&gt; (obligatorio) id_grupo.
 
*id=&lt;group_id&gt; (obligatorio) id_grupo.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_group&id=303&apipass=1234&user=admin&pass=pandora</nowiki>
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_group&id=303&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set add_user_profile====
+
===set add_user_profile===
 
 
 
Añade un perfil a un usuario.
 
Añade un perfil a un usuario.
  
Line 2,986: Line 2,851:
 
:*&lt;profile&gt;
 
:*&lt;profile&gt;
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_user_profile&id=md&other=12|4&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_user_profile&id=md&other=12|4&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set delete_user_profile====
+
===set delete_user_profile===
 
 
 
Quita un perfil a un usuario.
 
Quita un perfil a un usuario.
  
Line 3,001: Line 2,865:
 
:*&lt;profile&gt;
 
:*&lt;profile&gt;
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_user_profile&id=md&other=12|4&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_user_profile&id=md&other=12|4&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set new_incident====
+
===set new_incident===
 
 
 
Crea un nuevo incidente.
 
Crea un nuevo incidente.
  
Line 3,019: Line 2,882:
 
:*&lt;grupo&gt;
 
:*&lt;grupo&gt;
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_incident&other=titulo|descripcion%20texto|Logfiles|2|10|12&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_incident&other=titulo|descripcion%20texto|Logfiles|2|10|12&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set new_note_incident====
+
===set new_note_incident===
 
 
 
Crea una nota dentro de una incidencia.
 
Crea una nota dentro de una incidencia.
  
Line 3,033: Line 2,895:
 
*other=&lt;nota&gt; (obligatorio) es la nota codificada en url encode.
 
*other=&lt;nota&gt; (obligatorio) es la nota codificada en url encode.
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_note_incident&id=5&id2=miguel&other=una%20nota%20para%20la%20incidencia&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_note_incident&id=5&id2=miguel&other=una%20nota%20para%20la%20incidencia&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set validate_all_alerts====
+
===set validate_all_alerts===
 
 
 
Valida todas las alertas.
 
Valida todas las alertas.
  
Line 3,044: Line 2,905:
 
*op2=validate_all_alerts (obligatorio)
 
*op2=validate_all_alerts (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_alerts&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_alerts&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set validate_all_policy_alerts====
+
===set validate_all_policy_alerts===
 
 
 
Valida todas las alertas que vienen de políticas.
 
Valida todas las alertas que vienen de políticas.
  
Line 3,055: Line 2,915:
 
*op2=validate_all_policy_alerts (obligatorio)
 
*op2=validate_all_policy_alerts (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_policy_alerts&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_policy_alerts&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set event_validate_filter====
+
===set event_validate_filter===
 
 
 
Valida todos los eventos que pasan el filtro pasado como parámetros.
 
Valida todos los eventos que pasan el filtro pasado como parámetros.
  
Line 3,079: Line 2,938:
 
:*&lt;nivel máximo intervalo numérico &gt; en unix timestamp
 
:*&lt;nivel máximo intervalo numérico &gt; en unix timestamp
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=event_validate_filter&other_mode=url_encode_separator_|&other=;|2&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=event_validate_filter&other_mode=url_encode_separator_|&other=;|2&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set event_validate_filter_pro====
+
===set event_validate_filter_pro===
 
 
 
Es igual que la anterior.
 
Es igual que la anterior.
  
Line 3,104: Line 2,961:
 
:*&lt;nivel máximo intervalo numérico &gt; en unix timestamp
 
:*&lt;nivel máximo intervalo numérico &gt; en unix timestamp
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=event_validate_filter_pro&other_mode=url_encode_separator_|&other=;|2&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=event_validate_filter_pro&other_mode=url_encode_separator_|&other=;|2&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set new_alert_template====
+
===set new_alert_template===
 
Aplica una alerta desde una plantilla y un módulo pasado como id de agente y nombre de módulo.
 
Aplica una alerta desde una plantilla y un módulo pasado como id de agente y nombre de módulo.
  
Line 3,121: Line 2,977:
 
:*&lt;nombre modulo&gt; (obligatorio)
 
:*&lt;nombre modulo&gt; (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_alert_template&id=example&id2=test&other_mode=url_encode_separator_|&other=memfree&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_alert_template&id=example&id2=test&other_mode=url_encode_separator_|&other=memfree&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set alert_actions====
+
===set alert_actions===
 
 
 
Añade acciones a una alerta.
 
Añade acciones a una alerta.
  
Line 3,141: Line 2,995:
 
:*&lt;fires max &gt; (opcional)
 
:*&lt;fires max &gt; (opcional)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=alert_actions&id=example&id2=test&other_mode=url_encode_separator_|&other=memfree|test&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=alert_actions&id=example&id2=test&other_mode=url_encode_separator_|&other=memfree|test&apipass=1234&user=admin&pass=pandora</nowiki>
  
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=alert_actions&id=example&id2=test&other_mode=url_encode_separator_|&other=memfree|test|1|3&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=alert_actions&id=example&id2=test&other_mode=url_encode_separator_|&other=memfree|test|1|3&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set alert_commands====
+
===set alert_commands===
 
 
 
Añade comandos a una alerta.
 
Añade comandos a una alerta.
  
Line 3,162: Line 3,015:
 
:*&lt;field_description_1&gt;&lt;field_value_1&gt;&lt;field_description_2&gt;&lt;field_value_2&gt;...&lt;field_description_n&gt;&lt;field_value_n&gt;
 
:*&lt;field_description_1&gt;&lt;field_value_1&gt;&lt;field_description_2&gt;&lt;field_value_2&gt;...&lt;field_description_n&gt;&lt;field_value_n&gt;
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=alert_commands&id=PRUEBA1&other=command|0|Desc|1|des1|val1|des2|val2|des3|val3||val4|des5&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=alert_commands&id=PRUEBA1&other=command|0|Desc|1|des1|val1|des2|val2|des3|val3||val4|des5&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set new_module====
+
===set new_module===
 
Crea un nuevo módulo.
 
Crea un nuevo módulo.
  
Line 3,191: Line 3,044:
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_module&id=miguel-portatil&id2=juanito&other_mode=url_encode_separator_|&other=remote_tcp_string|localhost|33|descripcion%20larga&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_module&id=miguel-portatil&id2=juanito&other_mode=url_encode_separator_|&other=remote_tcp_string|localhost|33|descripcion%20larga&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set delete_module====
+
===set delete_module===
 
Borra un módulo.
 
Borra un módulo.
  
Line 3,204: Line 3,057:
 
*other=simulate (opcional)
 
*other=simulate (opcional)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module&id=example&id2=example2&other=simulate&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module&id=example&id2=example2&other=simulate&apipass=1234&user=admin&pass=pandora</nowiki>
  
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module&id=example&id2=example2&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module&id=example&id2=example2&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set enable_alert====
+
===set enable_alert===
 
Activa una alerta dentro de un agente.
 
Activa una alerta dentro de un agente.
  
Line 3,221: Line 3,074:
  
  
===== Ejemplo =====
+
==== Ejemplo ====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=enable_alert&id=example&id2=Status&other=Warning%20condition&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=enable_alert&id=example&id2=Status&other=Warning%20condition&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set enable_alert_alias====
+
===set enable_alert_alias===
 
 
 
Activa una alerta dentro de un agente a partir del alias.
 
Activa una alerta dentro de un agente a partir del alias.
  
Line 3,238: Line 3,089:
  
  
===== Ejemplo =====
+
==== Ejemplo ====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=enable_alert_alias&id=example&id2=CPU%20Load&other=critical%20condition&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=enable_alert_alias&id=example&id2=CPU%20Load&other=critical%20condition&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set disable_alert====
+
===set disable_alert===
 
 
 
Desactiva una alerta dentro de un agente.
 
Desactiva una alerta dentro de un agente.
  
Line 3,255: Line 3,104:
  
  
===== Ejemplo =====
+
==== Ejemplo ====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=disable_alert&id=example&id2=Status&other=Warning%20condition&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=disable_alert&id=example&id2=Status&other=Warning%20condition&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set disable_alert_alias====
+
===set disable_alert_alias===
 
 
 
Desactiva una alerta dentro de un agente.
 
Desactiva una alerta dentro de un agente.
  
Line 3,272: Line 3,119:
  
  
===== Ejemplo =====
+
==== Ejemplo ====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=disable_alert_alias&id=example&id2=CPU%20Load&other=critical%20condition&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=disable_alert_alias&id=example&id2=CPU%20Load&other=critical%20condition&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set enable_module_alerts====
+
===set enable_module_alerts===
 
 
 
Igual que la llamada enable_alert.
 
Igual que la llamada enable_alert.
  
Line 3,288: Line 3,133:
  
  
===== Ejemplo =====
+
==== Ejemplo ====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=enable_module_alerts&id=example&id2=Status&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=enable_module_alerts&id=example&id2=Status&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set disable_module_alerts====
+
===set disable_module_alerts===
 
 
 
Igual que la llamada disable_alert.
 
Igual que la llamada disable_alert.
  
Line 3,304: Line 3,147:
  
  
===== Ejemplo =====
+
==== Ejemplo ====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=disable_module_alerts&id=example&id2=Status&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=disable_module_alerts&id=example&id2=Status&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set enable_module====
+
===set enable_module===
 
 
 
Activa el módulo.
 
Activa el módulo.
  
Line 3,320: Line 3,161:
  
  
===== Ejemplo =====
+
==== Ejemplo ====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=enable_module&id=example&id2=Status&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=enable_module&id=example&id2=Status&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set disable_module====
+
===set disable_module===
 
 
 
Desactiva el módulo.
 
Desactiva el módulo.
  
Line 3,336: Line 3,175:
  
  
===== Ejemplo =====
+
==== Ejemplo ====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=disable_module&id=example&id2=Status&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=disable_module&id=example&id2=Status&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set create_network_module_from_component====
+
===set create_network_module_from_component===
 
 
 
Crea un nuevo módulo de red desde un componente.
 
Crea un nuevo módulo de red desde un componente.
  
Line 3,352: Line 3,189:
  
  
===== Ejemplo =====
+
==== Ejemplo ====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=create_network_module_from_component&id=example&id2=OS%20Total%20process&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=create_network_module_from_component&id=example&id2=OS%20Total%20process&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set module_data====
+
===set module_data===
 
 
 
Añade un nuevo valor al módulo.
 
Añade un nuevo valor al módulo.
  
Line 3,368: Line 3,203:
 
**tiempo: puede ser la cadena de texto "now" para el momento actual o el timestamp especifico.
 
**tiempo: puede ser la cadena de texto "now" para el momento actual o el timestamp especifico.
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=module_data&id=14&other_mode=url_encode_separator_|&other=123|now&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=module_data&id=14&other_mode=url_encode_separator_|&other=123|now&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set new_module_group====
+
===set new_module_group===
 
 
 
Crea un nuevo grupo de módulos.
 
Crea un nuevo grupo de módulos.
  
Line 3,380: Line 3,214:
 
*id=&lt;nombre del grupo de módulos&gt; (obligatorio)
 
*id=&lt;nombre del grupo de módulos&gt; (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=new_module_group&id=Module_group_name&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=new_module_group&id=Module_group_name&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set module_group_synch====
+
===set module_group_synch===
 
 
 
{{metaconsola}}
 
{{metaconsola}}
 
Sincronizar grupo de módulos desde la metaconsola.
 
Sincronizar grupo de módulos desde la metaconsola.
Line 3,394: Line 3,227:
 
:*&lt;server_name_1&gt;&lt;server_name_2&gt;...&lt;server_name_n&gt; (obligatorio)
 
:*&lt;server_name_1&gt;&lt;server_name_2&gt;...&lt;server_name_n&gt; (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=module_group_synch&other=server_name1|server_name2|server_name3&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=module_group_synch&other=server_name1|server_name2|server_name3&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set add_module_in_conf====
+
===set add_module_in_conf===
 
>= 5.0 (Sólo Enterprise)
 
>= 5.0 (Sólo Enterprise)
  
Line 3,409: Line 3,242:
 
*other: los datos del modulo que irán en el fichero de configuración codificados en base64 (obligatorio)
 
*other: los datos del modulo que irán en el fichero de configuración codificados en base64 (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_module_in_conf&apipass=1234&user=admin&pass=pandora&id=9043&id2=example_name&other=bW9kdWxlX2JlZ2luCm1vZHVsZV9uYW1lIGV4YW1wbGVfbmFtZQptb2R1bGVfdHlwZSBnZW5lcmljX2RhdGEKbW9kdWxlX2V4ZWMgZWNobyAxOwptb2R1bGVfZW5k</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_module_in_conf&apipass=1234&user=admin&pass=pandora&id=9043&id2=example_name&other=bW9kdWxlX2JlZ2luCm1vZHVsZV9uYW1lIGV4YW1wbGVfbmFtZQptb2R1bGVfdHlwZSBnZW5lcmljX2RhdGEKbW9kdWxlX2V4ZWMgZWNobyAxOwptb2R1bGVfZW5k</nowiki>
  
 
Se retornará '0' en caso de éxito,'-1' en caso de error, '-2' si ya existe
 
Se retornará '0' en caso de éxito,'-1' en caso de error, '-2' si ya existe
  
====set delete_module_in_conf====
+
===set delete_module_in_conf===
 
>= 5.0 (Sólo Enterprise)
 
>= 5.0 (Sólo Enterprise)
  
Line 3,425: Line 3,258:
 
*id2=&lt;nombre módulo&gt; (obligatorio)
 
*id2=&lt;nombre módulo&gt; (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_module_in_conf&user=admin&pass=pandora&id=9043&id2=example_name</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_module_in_conf&user=admin&pass=pandora&id=9043&id2=example_name</nowiki>
  
 
Se retornará '0' en caso de éxito ó '-1' en caso de error
 
Se retornará '0' en caso de éxito ó '-1' en caso de error
  
====set update_module_in_conf====
+
===set update_module_in_conf===
 
>= 5.0 (Sólo Enterprise)
 
>= 5.0 (Sólo Enterprise)
  
Line 3,442: Line 3,275:
 
*other: los nuevos datos del módulo que irán en el fichero de configuración codificados en base64 (obligatorio)
 
*other: los nuevos datos del módulo que irán en el fichero de configuración codificados en base64 (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_module_in_conf&apipass=1234&user=admin&pass=pandora&id=9043&id2=example_name&other=bW9kdWxlX2JlZ2luCm1vZHVsZV9uYW1lIGV4YW1wbGVfbmFtZQptb2R1bGVfdHlwZSBnZW5lcmljX2RhdGEKbW9kdWxlX2V4ZWMgZWNobyAxOwptb2R1bGVfZW5k</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_module_in_conf&apipass=1234&user=admin&pass=pandora&id=9043&id2=example_name&other=bW9kdWxlX2JlZ2luCm1vZHVsZV9uYW1lIGV4YW1wbGVfbmFtZQptb2R1bGVfdHlwZSBnZW5lcmljX2RhdGEKbW9kdWxlX2V4ZWMgZWNobyAxOwptb2R1bGVfZW5k</nowiki>
  
 
Se retornará '1' si no cambia, '0' en caso de éxito, '-1' en caso de error, '-2' si no existe
 
Se retornará '1' si no cambia, '0' en caso de éxito, '-1' en caso de error, '-2' si no existe
  
====set create_event====
+
===set create_event===
 
 
 
Crea un evento nuevo en Pandora.
 
Crea un evento nuevo en Pandora.
  
Line 3,478: Line 3,310:
 
:*&lt;id_extra&gt; (alphanumeric)
 
:*&lt;id_extra&gt; (alphanumeric)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_event&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora&other=Event_name|0|1|0|admin|alert_fired|4|1|||||comment|admin||tags|eyJBbnN3ZXIgdG8gdGhlIFVsdGltYXRlIFF1ZXN0aW9uIG9mIExpZmUsIHRoZSBVbml2ZXJzZSwgYW5kIEV2ZXJ5dGhpbmciOiA0Mn0=||12</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_event&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora&other=Event_name|0|1|0|admin|alert_fired|4|1|||||comment|admin||tags|eyJBbnN3ZXIgdG8gdGhlIFVsdGltYXRlIFF1ZXN0aW9uIG9mIExpZmUsIHRoZSBVbml2ZXJzZSwgYW5kIEV2ZXJ5dGhpbmciOiA0Mn0=||12</nowiki>
  
====set add_event_comment====
+
===set add_event_comment===
 
 
 
Añade un comentario acerca del evento
 
Añade un comentario acerca del evento
  
Line 3,497: Line 3,327:
 
{{Tip|Para poder utilizarla en Metaconsola, se debe introducir el parámetro true despues del string}}
 
{{Tip|Para poder utilizarla en Metaconsola, se debe introducir el parámetro true despues del string}}
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
* Nodo:
 
* Nodo:
  
Line 3,507: Line 3,336:
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_event_comment&id=event_id&other=string|true&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_event_comment&id=event_id&other=string|true&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set create_netflow_filter====
+
===set create_netflow_filter===
 
(>=5.0)
 
(>=5.0)
  
Line 3,522: Line 3,351:
 
:*&lt;formato_salida&gt; (Valores posibles: kilobytes,kilobytespersecond,megabytes,megabytespersecond) (obligatorio)
 
:*&lt;formato_salida&gt; (Valores posibles: kilobytes,kilobytespersecond,megabytes,megabytespersecond) (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora/include/api.php?op=set&op2=create_netflow_filter&apipass=1234&user=admin&pass=pandora&other=Filter%20name|9|host%20192.168.50.3%20OR%20host%20192.168.50.4%20or%20HOST%20192.168.50.6|dstport|kilobytes&other_mode=url_encode_separator_|</nowiki>
 
  <nowiki>http://127.0.0.1/pandora/include/api.php?op=set&op2=create_netflow_filter&apipass=1234&user=admin&pass=pandora&other=Filter%20name|9|host%20192.168.50.3%20OR%20host%20192.168.50.4%20or%20HOST%20192.168.50.6|dstport|kilobytes&other_mode=url_encode_separator_|</nowiki>
  
====set create_custom_field====
+
===set create_custom_field===
 
>= 5.0
 
>= 5.0
  
Line 3,538: Line 3,366:
 
:*&lt;flag_display_front&gt; (obligatorio; 0 no se mostrará en la vista de operación, 1 si se mostrará)
 
:*&lt;flag_display_front&gt; (obligatorio; 0 no se mostrará en la vista de operación, 1 si se mostrará)
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_custom_field&other=mycustomfield|0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_custom_field&other=mycustomfield|0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set create_tag====
+
===set create_tag===
 
>= 5.0
 
>= 5.0
  
Line 3,556: Line 3,383:
 
:*&lt;email&gt; Email del tag
 
:*&lt;email&gt; Email del tag
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_tag&other=tag_name|tag_description|tag_url|tag_email&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_tag&other=tag_name|tag_description|tag_url|tag_email&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set enable_disable_agent====
+
===set enable_disable_agent===
 
 
 
Activa un agente desactivado.
 
Activa un agente desactivado.
  
Line 3,570: Line 3,395:
 
*id=&lt;id_agente&gt; (obligatorio) debe ser un id agente.
 
*id=&lt;id_agente&gt; (obligatorio) debe ser un id agente.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
Example 1 (Disable agent 'example_id')  
 
Example 1 (Disable agent 'example_id')  
  
Line 3,580: Line 3,404:
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_agent&id=example_id&other=1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_agent&id=example_id&other=1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set gis_agent_only_position====
+
===set gis_agent_only_position===
 
>= 5.0
 
>= 5.0
  
Line 3,594: Line 3,418:
 
:*&lt;altitude&gt; Altitud
 
:*&lt;altitude&gt; Altitud
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=gis_agent_only_position&id=582&other_mode=url_encode_separator_|&other=2%7C1%7C0</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=gis_agent_only_position&id=582&other_mode=url_encode_separator_|&other=2%7C1%7C0</nowiki>
  
====set gis_agent====
+
===set gis_agent===
 
>= 5.0
 
>= 5.0
  
Line 3,623: Line 3,446:
  
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora5/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=gis_agent&id=582&other_mode=url_encode_separator_|&other=2%7C2%7C0%7C0%7C0%7C2000-01-01+01%3A01%3A01%7C0%7C666%7Caaa%7Cbbb%7Cccc</nowiki>
 
  <nowiki>http://127.0.0.1/pandora5/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=gis_agent&id=582&other_mode=url_encode_separator_|&other=2%7C2%7C0%7C0%7C0%7C2000-01-01+01%3A01%3A01%7C0%7C666%7Caaa%7Cbbb%7Cccc</nowiki>
  
====set reset_agent_counts====
+
===set reset_agent_counts===
 
 
 
Actualiza el conteo de módulos y alertas de un agente.
 
Actualiza el conteo de módulos y alertas de un agente.
  
Line 3,636: Line 3,457:
 
*id=<id_agent> (obligatorio) debe ser un id de agente o "All".
 
*id=<id_agent> (obligatorio) debe ser un id de agente o "All".
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=reset_agent_counts&apipass=1234&user=admin&pass=pandora&id=All</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=reset_agent_counts&apipass=1234&user=admin&pass=pandora&id=All</nowiki>
  
====set create_special_day====
+
===set create_special_day===
 
>= 5.1
 
>= 5.1
  
Line 3,655: Line 3,475:
 
:*&lt;id_group&gt; Id Grupo
 
:*&lt;id_group&gt; Id Grupo
  
=====Example=====
+
====Example====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1111&user=admin&pass=pandora&op=set&op2=create_special_day&other_mode=url_encode_separator_|&other=2014-05-03|Sunday|desc|0</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1111&user=admin&pass=pandora&op=set&op2=create_special_day&other_mode=url_encode_separator_|&other=2014-05-03|Sunday|desc|0</nowiki>
  
====set update_special_day====
+
===set update_special_day===
 
>= 5.1
 
>= 5.1
  
Line 3,675: Line 3,494:
 
:*&lt;id_group&gt; Id grupo
 
:*&lt;id_group&gt; Id grupo
  
=====Example=====
+
====Example====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1111&user=admin&pass=pandora&op=set&op2=update_special_day&id=1&other_mode=url_encode_separator_|&other=2014-05-03|Sunday|desc|0</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1111&user=admin&pass=pandora&op=set&op2=update_special_day&id=1&other_mode=url_encode_separator_|&other=2014-05-03|Sunday|desc|0</nowiki>
  
====set delete_special_day====
+
===set delete_special_day===
 
>= 5.1
 
>= 5.1
  
Line 3,690: Line 3,508:
 
*id=&lt;id día especial&gt; (obligatorio)
 
*id=&lt;id día especial&gt; (obligatorio)
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1111&user=admin&pass=pandora&op=set&op2=delete_special_day&id=1</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1111&user=admin&pass=pandora&op=set&op2=delete_special_day&id=1</nowiki>
  
====set pagerduty_webhook====
+
===set pagerduty_webhook===
 
>= 5.1
 
>= 5.1
  
Line 3,705: Line 3,522:
 
*id=alert (obligatorio)
 
*id=alert (obligatorio)
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=pagerduty_webhook&apipass=1234&user=admin&pass=pandora&id=alert</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=pagerduty_webhook&apipass=1234&user=admin&pass=pandora&id=alert</nowiki>
  
====set tag_user_profile====
+
===set tag_user_profile===
 
>= 6
 
>= 6
  
Line 3,724: Line 3,540:
  
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=tag_user_profile&apipass=1234&user=admin&pass=pandora&id=1&id2=2&other_mode=url_encode_separator_|&other=122|3</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=tag_user_profile&apipass=1234&user=admin&pass=pandora&id=1&id2=2&other_mode=url_encode_separator_|&other=122|3</nowiki>
  
====set tag====
+
===set tag===
 
>= 6
 
>= 6
  
Line 3,742: Line 3,557:
  
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=tag&apipass=1234&user=admin&pass=pandora&id=test&other_mode=url_encode_separator_|&other="un test"|http://www.artica.es|[email protected]|01189998819991197253</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=tag&apipass=1234&user=admin&pass=pandora&id=test&other_mode=url_encode_separator_|&other="un test"|http://www.artica.es|[email protected]|01189998819991197253</nowiki>
  
====set add_tag_module====
+
===set add_tag_module===
 
>= 6
 
>= 6
  
Line 3,759: Line 3,573:
  
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_tag_module&apipass=1234&user=admin&pass=pandora&id=1&id2=2</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_tag_module&apipass=1234&user=admin&pass=pandora&id=1&id2=2</nowiki>
  
====set remove_tag_module====
+
===set remove_tag_module===
 
>= 6
 
>= 6
  
Line 3,776: Line 3,589:
  
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_tag_module&apipass=1234&user=admin&pass=pandora&id=1&id2=2</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_tag_module&apipass=1234&user=admin&pass=pandora&id=1&id2=2</nowiki>
  
====set planned_downtimes_created====
+
===set planned_downtimes_created===
 
>= 5.1
 
>= 5.1
  
Line 3,791: Line 3,603:
 
*  <periodically_day_from>;<periodically_day_to>;<type_downtime>;<type_execution>;<type_periodicity>;<id_user>;
 
*  <periodically_day_from>;<periodically_day_to>;<type_downtime>;<type_execution>;<type_periodicity>;<id_user>;
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
Once:
 
Once:
  
Line 3,801: Line 3,612:
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=planned_downtimes_created&apipass=1234&user=admin&pass=pandora&id=testing&other=testing|11/05/2018|11/16/2018|0|1|1|1|1|1|1|1|12:06:00|19:06:00|1|31|quiet|periodically|weekly|admin&other_mode=url_encode_separator_|</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=planned_downtimes_created&apipass=1234&user=admin&pass=pandora&id=testing&other=testing|11/05/2018|11/16/2018|0|1|1|1|1|1|1|1|12:06:00|19:06:00|1|31|quiet|periodically|weekly|admin&other_mode=url_encode_separator_|</nowiki>
  
====set planned_downtimes_additem====
+
===set planned_downtimes_additem===
 
>= 5.1
 
>= 5.1
  
Line 3,810: Line 3,621:
 
*other= <id_agent1;id_agent2;id_agent3;....id_agentn;>;<name_module1;name_module2;name_module3;......name_modulen;>
 
*other= <id_agent1;id_agent2;id_agent3;....id_agentn;>;<name_module1;name_module2;name_module3;......name_modulen;>
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_additem&apipass=1234&user=admin&pass=pandora&id=123&other=1;2;3;4%7CStatus;Unkown_modules%20&other_mode=url_encode_separator_|</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_additem&apipass=1234&user=admin&pass=pandora&id=123&other=1;2;3;4%7CStatus;Unkown_modules%20&other_mode=url_encode_separator_|</nowiki>
  
====set planned_downtimes_deleted====
+
===set planned_downtimes_deleted===
 
>=5.1
 
>=5.1
  
Line 3,822: Line 3,632:
 
*id=planned_downtime_id
 
*id=planned_downtime_id
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_deleted&apipass=1234&user=admin&pass=pandora&id=10</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_deleted&apipass=1234&user=admin&pass=pandora&id=10</nowiki>
  
====set create_synthetic_module====
+
===set create_synthetic_module===
 
>=5.1SP4
 
>=5.1SP4
  
Line 3,843: Line 3,652:
 
   average: Only AVG
 
   average: Only AVG
  
=====Ejemplo=====
+
====Ejemplo====
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_synthetic_module&apipass=1234&user=admin&pass=pandora&id=test&other=Test|arithmetic|Agent%20Name;Module%20Name|Agent%20Name2;ADD;Module%20Name2&other_mode=url_encode_separator_|</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_synthetic_module&apipass=1234&user=admin&pass=pandora&id=test&other=Test|arithmetic|Agent%20Name;Module%20Name|Agent%20Name2;ADD;Module%20Name2&other_mode=url_encode_separator_|</nowiki>
  
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_synthetic_module&apipass=1234&user=admin&pass=pandora&id=example&other=prueba|average|Agent%20Name;AVG;Name%20Module|Agent%20Name2;AVG;Name%20Module2&other_mode=url_encode_separator_|</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_synthetic_module&apipass=1234&user=admin&pass=pandora&id=example&other=prueba|average|Agent%20Name;AVG;Name%20Module|Agent%20Name2;AVG;Name%20Module2&other_mode=url_encode_separator_|</nowiki>
  
====set create_service====
+
===set create_service===
 
>= 7
 
>= 7
  
Line 3,858: Line 3,667:
 
<id_warning_module_template_alert>;<id_critical_module_template_alert>;<id_critical_module_sla_template_alert>;
 
<id_warning_module_template_alert>;<id_critical_module_template_alert>;<id_critical_module_sla_template_alert>;
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_service&return_type=json&other=test1%7CDescripcion%7C12%7C1%7C0.5%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_service&return_type=json&other=test1%7CDescripcion%7C12%7C1%7C0.5%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set update_service====
+
===set update_service===
 
>= 7
 
>= 7
  
Line 3,873: Line 3,681:
 
<id_warning_module_template_alert>;<id_critical_module_template_alert>;<id_critical_module_sla_template_alert>;
 
<id_warning_module_template_alert>;<id_critical_module_template_alert>;<id_critical_module_sla_template_alert>;
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_service&return_type=json&id=1&other=test2%7CDescripcion2%7C%7C%7C0.6%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_service&return_type=json&id=1&other=test2%7CDescripcion2%7C%7C%7C0.6%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set add_element_service====
+
===set add_element_service===
 
>= 7
 
>= 7
  
Line 3,900: Line 3,707:
  
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_element_service&return_type=json&id=6&other=W3sidHlwZSI6ImFnZW50IiwiaWQiOjIsImRlc2NyaXB0aW9uIjoiamlqaWppIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH0seyJ0eXBlIjoibW9kdWxlIiwiaWQiOjEsImRlc2NyaXB0aW9uIjoiSG9sYSBxdWUgdGFsIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH0seyJ0eXBlIjoic2VydmljZSIsImlkIjozLCJkZXNjcmlwdGlvbiI6ImplamVqZWplIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH1d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_element_service&return_type=json&id=6&other=W3sidHlwZSI6ImFnZW50IiwiaWQiOjIsImRlc2NyaXB0aW9uIjoiamlqaWppIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH0seyJ0eXBlIjoibW9kdWxlIiwiaWQiOjEsImRlc2NyaXB0aW9uIjoiSG9sYSBxdWUgdGFsIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH0seyJ0eXBlIjoic2VydmljZSIsImlkIjozLCJkZXNjcmlwdGlvbiI6ImplamVqZWplIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH1d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set metaconsole_synch====
+
===set metaconsole_synch===
 
>= 7
 
>= 7
  
Line 3,913: Line 3,719:
 
*id=Código de licencia
 
*id=Código de licencia
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/enterprise/meta/include/api.php?op=set&op2=metaconsole_synch&id=CODIGODELICENCIA&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/enterprise/meta/include/api.php?op=set&op2=metaconsole_synch&id=CODIGODELICENCIA&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set migrate_agent====
+
===set migrate_agent===
 
>= 7.21 ONLY METACONSOLE
 
>= 7.21 ONLY METACONSOLE
  
Line 3,929: Line 3,734:
 
*return_type = string, json, etc
 
*return_type = string, json, etc
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=migrate_agent&apipass=1234&user=admin&pass=pandora&id=2&other=example|example2|0&other_mode=url_encode_separator_|&return_type=string</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=migrate_agent&apipass=1234&user=admin&pass=pandora&id=2&other=example|example2|0&other_mode=url_encode_separator_|&return_type=string</nowiki>
  
====set new_cluster====
+
===set new_cluster===
 
>= 7.0
 
>= 7.0
  
Line 3,945: Line 3,749:
 
*other_mode=url_encode_separator_
 
*other_mode=url_encode_separator_
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_cluster&other=nombre_cluster%7CAA%7Cdescripcion%7C12&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_cluster&other=nombre_cluster%7CAA%7Cdescripcion%7C12&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set add_cluster_agent====
+
===set add_cluster_agent===
 
>= 7.0
 
>= 7.0
  
Line 3,966: Line 3,769:
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_agent&other=W3siaWQiOjUsImlkX2FnZW50IjoyfSwKeyJpZCI6NSwiaWRfYWdlbnQiOjN9XQ==&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_agent&other=W3siaWQiOjUsImlkX2FnZW50IjoyfSwKeyJpZCI6NSwiaWRfYWdlbnQiOjN9XQ==&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set add_cluster_item (activo/activo)====
+
===set add_cluster_item (activo/activo)===
 
>= 7.0
 
>= 7.0
  
Line 3,983: Line 3,786:
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_item&other=W3sibmFtZSI6IlN3YXBfVXNlZCIsImlkX2NsdXN0ZXIiOjUsInR5cGUiOiJBQSIsImNyaXRpY2FsX2xpbWl0Ijo4MCwid2FybmluZ19saW1pdCI6NjB9LAp7Im5hbWUiOiJUQ1BfQ29ubmVjdGlvbnMiLCJpZF9jbHVzdGVyIjo1LCJ0eXBlIjoiQUEiLCJjcml0aWNhbF9saW1pdCI6ODAsIndhcm5pbmdfbGltaXQiOjYwfV0=&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_item&other=W3sibmFtZSI6IlN3YXBfVXNlZCIsImlkX2NsdXN0ZXIiOjUsInR5cGUiOiJBQSIsImNyaXRpY2FsX2xpbWl0Ijo4MCwid2FybmluZ19saW1pdCI6NjB9LAp7Im5hbWUiOiJUQ1BfQ29ubmVjdGlvbnMiLCJpZF9jbHVzdGVyIjo1LCJ0eXBlIjoiQUEiLCJjcml0aWNhbF9saW1pdCI6ODAsIndhcm5pbmdfbGltaXQiOjYwfV0=&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set add_cluster_item (active/passive)====
+
===set add_cluster_item (active/passive)===
 
>= 7.0
 
>= 7.0
  
Line 4,000: Line 3,803:
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_item&other=W3sibmFtZSI6IkRpc2tVc2VkXy9wcm9jL2tjb3JlIiwiaWRfY2x1c3RlciI6NSwidHlwZSI6IkFQIiwiaXNfY3JpdGljYWwiOjF9LAp7Im5hbWUiOiJEaXNrVXNlZF8vcHJvYy9zY2hlZF9kZWJ1ZyIsImlkX2NsdXN0ZXIiOjUsInR5cGUiOiJBUCIsImlzX2NyaXRpY2FsIjoxfV0=&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_item&other=W3sibmFtZSI6IkRpc2tVc2VkXy9wcm9jL2tjb3JlIiwiaWRfY2x1c3RlciI6NSwidHlwZSI6IkFQIiwiaXNfY3JpdGljYWwiOjF9LAp7Im5hbWUiOiJEaXNrVXNlZF8vcHJvYy9zY2hlZF9kZWJ1ZyIsImlkX2NsdXN0ZXIiOjUsInR5cGUiOiJBUCIsImlzX2NyaXRpY2FsIjoxfV0=&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set delete_cluster====
+
===set delete_cluster===
 
>= 7.0
 
>= 7.0
  
Line 4,011: Line 3,814:
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster&id=7&apipass=1234&user=admin&pass=pandora</nowiki>
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster&id=7&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set delete_cluster_agents====
+
===set delete_cluster_agents===
 
>= 7.0
 
>= 7.0
  
Line 4,026: Line 3,829:
 
{"id":5,"id_agent":3}]
 
{"id":5,"id_agent":3}]
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster_agent&other=W3siaWQiOjUsImlkX2FnZW50IjoyfSwKeyJpZCI6NSwiaWRfYWdlbnQiOjN9XQ==&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster_agent&other=W3siaWQiOjUsImlkX2FnZW50IjoyfSwKeyJpZCI6NSwiaWRfYWdlbnQiOjN9XQ==&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set delete_cluster_item====
+
===set delete_cluster_item===
 
>= 7.0
 
>= 7.0
  
Line 4,041: Line 3,843:
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster_item&id=9&apipass=1234&user=admin&pass=pandora</nowiki>
 
   <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster_item&id=9&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set create_policy====
+
===set create_policy===
 
>= 7.0. 725
 
>= 7.0. 725
  
Line 4,053: Line 3,855:
 
*return_type = (string, csv, json).
 
*return_type = (string, csv, json).
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=create_policy&apipass=1234&user=admin&pass=pandora&other=name%20Policy|11|this%20description&other_mode=url_encode_separator_|&return_type=json</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=create_policy&apipass=1234&user=admin&pass=pandora&other=name%20Policy|11|this%20description&other_mode=url_encode_separator_|&return_type=json</nowiki>
  
====set update_policy====
+
===set update_policy===
 
>= 7.0. 725
 
>= 7.0. 725
  
Line 4,071: Line 3,872:
 
*return_type = (string, csv, json).
 
*return_type = (string, csv, json).
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=update_policy&apipass=1234&user=admin&pass=pandora&id=17&other=policy2|11|this%20description&other_mode=url_encode_separator_|&return_type=json</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=update_policy&apipass=1234&user=admin&pass=pandora&id=17&other=policy2|11|this%20description&other_mode=url_encode_separator_|&return_type=json</nowiki>
  
====set delete_policy====
+
===set delete_policy===
 
>= 7.0. 725
 
>= 7.0. 725
  
Line 4,086: Line 3,886:
 
*return_type = (string, csv, json).
 
*return_type = (string, csv, json).
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_policy&apipass=1234&user=admin&pass=pandora&id=10&return_type=json</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_policy&apipass=1234&user=admin&pass=pandora&id=10&return_type=json</nowiki>
  
====set add_collections_policy====
+
===set add_collections_policy===
 
>= 7.0. 725
 
>= 7.0. 725
  
Line 4,102: Line 3,901:
 
*return_type = (string, csv, json).
 
*return_type = (string, csv, json).
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=add_collections_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=4&id2=apache_plugin</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=add_collections_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=4&id2=apache_plugin</nowiki>
  
====set remove_collections_policy====
+
===set remove_collections_policy===
 
>= 7.0. 725
 
>= 7.0. 725
  
Line 4,123: Line 3,921:
 
*return_type = (string, csv, json).
 
*return_type = (string, csv, json).
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=remove_collections_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=4&id2=2&other=1.</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=remove_collections_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=4&id2=2&other=1.</nowiki>
  
====set create_plugins_policy====
+
===set create_plugins_policy===
 
>= 7.0. 725
 
>= 7.0. 725
  
Line 4,142: Line 3,939:
 
*return_type = (string, csv, json).
 
*return_type = (string, csv, json).
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=create_plugins_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2&id2=echo%201</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=create_plugins_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2&id2=echo%201</nowiki>
  
====set delete_plugins_policy====
+
===set delete_plugins_policy===
 
>= 7.0. 725
 
>= 7.0. 725
  
Line 4,162: Line 3,958:
 
*return_type = (string, csv, json).
 
*return_type = (string, csv, json).
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_plugins_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=2&id2=1&other=1</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_plugins_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=2&id2=1&other=1</nowiki>
  
====set linking_policy====
+
===set linking_policy===
 
>= 7.0. 725
 
>= 7.0. 725
  
Line 4,179: Line 3,974:
 
*return_type = (string, csv, json).
 
*return_type = (string, csv, json).
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=linking_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=28</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=linking_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=28</nowiki>
  
====set create_alerts_policy====
+
===set create_alerts_policy===
 
>= 7.0. 725
 
>= 7.0. 725
  
Line 4,202: Line 3,996:
 
*return_type = (string, csv, json).
 
*return_type = (string, csv, json).
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=create_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=2&other=0|2|1|cpu%20load&other_mode=url_encode_separator_|</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=create_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=2&other=0|2|1|cpu%20load&other_mode=url_encode_separator_|</nowiki>
  
====set update_alerts_policy====
+
===set update_alerts_policy===
 
>= 7.0. 725
 
>= 7.0. 725
  
Line 4,222: Line 4,015:
 
*return_type = (string, csv, json).
 
*return_type = (string, csv, json).
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=update_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=7&other=1|1&other_mode=url_encode_separator_|</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=update_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=7&other=1|1&other_mode=url_encode_separator_|</nowiki>
  
====set delete_alerts_policy====
+
===set delete_alerts_policy===
 
>= 7.0. 725
 
>= 7.0. 725
  
Line 4,241: Line 4,033:
 
*return_type = (string, csv, json).
 
*return_type = (string, csv, json).
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=7&id2=1</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=7&id2=1</nowiki>
  
====set create_alerts_actions_policy====
+
===set create_alerts_actions_policy===
 
>= 7.0. 725
 
>= 7.0. 725
  
Line 4,262: Line 4,053:
 
*return_type = (string, csv, json).
 
*return_type = (string, csv, json).
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://172.16.0.2/pandora_console/include/api.php?op=set&op2=create_alerts_actions_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=1&id2=4&other=5|2&other_mode=url_encode_separator_|</nowiki>
 
  <nowiki>http://172.16.0.2/pandora_console/include/api.php?op=set&op2=create_alerts_actions_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=1&id2=4&other=5|2&other_mode=url_encode_separator_|</nowiki>
  
====set delete_alerts_actions_policy====
+
===set delete_alerts_actions_policy===
 
>= 7.0. 725
 
>= 7.0. 725
  
Line 4,279: Line 4,069:
 
*return_type = (string, csv, json).
 
*return_type = (string, csv, json).
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_alerts_actions_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=1&id2=4</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_alerts_actions_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=1&id2=4</nowiki>
  
====set remove_agents_policy====
+
===set remove_agents_policy===
 
>= 7.0. 725
 
>= 7.0. 725
  
Line 4,296: Line 4,085:
 
*return_type = (string, csv, json).
 
*return_type = (string, csv, json).
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=remove_agents_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=5&id2=2</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=remove_agents_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=5&id2=2</nowiki>
  
====set add_groups_policy====
+
===set add_groups_policy===
 
>= 7.0. 725
 
>= 7.0. 725
  
Line 4,313: Line 4,101:
 
*return_type = (string, csv, json).
 
*return_type = (string, csv, json).
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=add_groups_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=7&id2=12</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=add_groups_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=7&id2=12</nowiki>
  
====set remove_groups_policy====
+
===set remove_groups_policy===
 
>= 7.0. 725
 
>= 7.0. 725
  
Line 4,330: Line 4,117:
 
*return_type = (string, csv, json).
 
*return_type = (string, csv, json).
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=remove_groups_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=5&id2=2</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=remove_groups_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=5&id2=2</nowiki>
  
====set create_os====
+
===set create_os===
 
>= 7.0. 727
 
>= 7.0. 727
  
Line 4,347: Line 4,133:
 
:*&lt;icono&gt;
 
:*&lt;icono&gt;
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_os&other=os_name%7Cos_description%7Cos_icon.png&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_os&other=os_name%7Cos_description%7Cos_icon.png&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set update_os====
+
===set update_os===
 
>= 7.0. 727
 
>= 7.0. 727
  
Line 4,365: Line 4,150:
 
:*&lt;icono&gt;
 
:*&lt;icono&gt;
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?id=107&op=set&op2=update_os&other=os_name_to_update%7Cos_description_to_update%7Cos_icon_to_update.png&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?id=107&op=set&op2=update_os&other=os_name_to_update%7Cos_description_to_update%7Cos_icon_to_update.png&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set disabled_and_standby====
+
===set disabled_and_standby===
 
>= 7.0. 728
 
>= 7.0. 728
  
Line 4,381: Line 4,165:
 
*other=<valor> (opcional) Valor (0 para habilitar y 1 para deshabilitar) del nuevo estado. Si no se especifica ningún valor, deshabilita el agente.
 
*other=<valor> (opcional) Valor (0 para habilitar y 1 para deshabilitar) del nuevo estado. Si no se especifica ningún valor, deshabilita el agente.
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?id=2&op=set&op2=disabled_and_standby&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?id=2&op=set&op2=disabled_and_standby&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?id=2&id2=1&op=set&op2=disabled_and_standby&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?id=2&id2=1&op=set&op2=disabled_and_standby&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set validate_traps====
+
===set validate_traps===
 
>= 7.0. 728
 
>= 7.0. 728
  
Line 4,396: Line 4,179:
 
*id = id del trap
 
*id = id del trap
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>https://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_traps&id=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>https://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_traps&id=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set delete_traps====
+
===set delete_traps===
 
>= 7.0. 728
 
>= 7.0. 728
  
Line 4,409: Line 4,191:
 
*id = id del trap
 
*id = id del trap
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?id=2&op=set&op2=delete_traps&id=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?id=2&op=set&op2=delete_traps&id=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set access_process====
+
===set access_process===
 
>= 7.0NG. 728
 
>= 7.0NG. 728
  
Line 4,449: Line 4,230:
 
Prohibe el acceso de usuarios no administradores.
 
Prohibe el acceso de usuarios no administradores.
  
=====Ejemplo (requiere entorno adaptado)=====
+
====Ejemplo (requiere entorno adaptado)====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=access_process&other=1%7Clogin%7C192.168.50.25%7Cexternal_app%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=access_process&other=1%7Clogin%7C192.168.50.25%7Cexternal_app%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set create_event_response====
+
===set create_event_response===
 
Crea una nueva respuesta de evento.
 
Crea una nueva respuesta de evento.
  
Line 4,471: Line 4,251:
 
:*<parámetros> Parámetros que complementan la ejecución del comando.
 
:*<parámetros> Parámetros que complementan la ejecución del comando.
 
:*<servidor> Id del servidor donde se desea que se ejecute el comando. Para la consola local el valor es 0.
 
:*<servidor> Id del servidor donde se desea que se ejecute el comando. Para la consola local el valor es 0.
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=create_event_response&other=response%7Cdescription%20response%7Ctouch%7Ccommand%7C0%7C650%7C400%7C0%7Cresponse%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=create_event_response&other=response%7Cdescription%20response%7Ctouch%7Ccommand%7C0%7C650%7C400%7C0%7Cresponse%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set update_event_response====
+
===set update_event_response===
 
Edita una respuesta de evento existente. El usuario debe de tener permisos sobre el grupo al que pertenece la respuesta para poder editarla.
 
Edita una respuesta de evento existente. El usuario debe de tener permisos sobre el grupo al que pertenece la respuesta para poder editarla.
  
Line 4,494: Line 4,273:
 
:*<parámetros> Parámetros que complementan la ejecución del comando.
 
:*<parámetros> Parámetros que complementan la ejecución del comando.
 
:*<servidor> Id del servidor donde se desea que se ejecute el comando. Para la consola local el valor es 0.
 
:*<servidor> Id del servidor donde se desea que se ejecute el comando. Para la consola local el valor es 0.
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=update_event_response&id=7&other=response%7Cdescription%20response%7Ctouch%7Ccommand%7C0%7C650%7C400%7C0%7Cresponse%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=update_event_response&id=7&other=response%7Cdescription%20response%7Ctouch%7Ccommand%7C0%7C650%7C400%7C0%7Cresponse%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set delete_event_response====
+
===set delete_event_response===
 
Borra una respuesta de evento. El usuario debe de tener permisos sobre el grupo al que pertenece la respuesta para poder borrarla.
 
Borra una respuesta de evento. El usuario debe de tener permisos sobre el grupo al que pertenece la respuesta para poder borrarla.
  
Line 4,506: Line 4,284:
 
*return_type=csv|json
 
*return_type=csv|json
 
*id=<id de la respuesta de eventos> (obligatorio)  
 
*id=<id de la respuesta de eventos> (obligatorio)  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_event_response&id=7&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_event_response&id=7&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set create_user_profile_info====
+
===set create_user_profile_info===
 
 
 
Crea un nuevo perfil de usuario.
 
Crea un nuevo perfil de usuario.
  
Line 4,524: Line 4,300:
 
{{Tip|Para saber que permisos debemos activar, visite el siguiente [[Pandora:Documentation_es:Gestion_y_Administracion#Perfiles_en_Pandora_FMS | enlace.]]}}
 
{{Tip|Para saber que permisos debemos activar, visite el siguiente [[Pandora:Documentation_es:Gestion_y_Administracion#Perfiles_en_Pandora_FMS | enlace.]]}}
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
Este ejemplo crea un perfil que da un acceso de solo lectura a Pandora FMS, es decir, es igual que el perfil predefinido ''Operator (read)''.
 
Este ejemplo crea un perfil que da un acceso de solo lectura a Pandora FMS, es decir, es igual que el perfil predefinido ''Operator (read)''.
  
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=create_user_profile_info&return_type=json&other=API_profile%7C1%7C0%7C0%7C1%7C0%7C0%7C0%7C0%7C0%7C0%7C1%7C0%7C0%7C1%7C0%7C0%7C1%7C0%7C0%7C1%7C0%7C0%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=create_user_profile_info&return_type=json&other=API_profile%7C1%7C0%7C0%7C1%7C0%7C0%7C0%7C0%7C0%7C0%7C1%7C0%7C0%7C1%7C0%7C0%7C1%7C0%7C0%7C1%7C0%7C0%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set update_user_profile_info====
+
===set update_user_profile_info===
 
 
 
Actualiza nuevo perfil de usuario existente.
 
Actualiza nuevo perfil de usuario existente.
  
Line 4,544: Line 4,318:
 
{{Tip|Para saber que permisos debemos activar, visite el siguiente [[Pandora:Documentation_es:Gestion_y_Administracion#Perfiles_en_Pandora_FMS | enlace.]]}}
 
{{Tip|Para saber que permisos debemos activar, visite el siguiente [[Pandora:Documentation_es:Gestion_y_Administracion#Perfiles_en_Pandora_FMS | enlace.]]}}
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
En este ejemplo se cambia el nombre del perfil con ID 6 a ''API_profile_updated'' y se le dan todos los permisos (lectura, escritura y gestión) en lo relacionado a agentes y se elimina el permiso de lectura de eventos.
 
En este ejemplo se cambia el nombre del perfil con ID 6 a ''API_profile_updated'' y se le dan todos los permisos (lectura, escritura y gestión) en lo relacionado a agentes y se elimina el permiso de lectura de eventos.
  
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=update_user_profile_info&return_type=json&id=6&other=API_profile_updated%7C%7C%7C%7C1%7C1%7C1%7C%7C%7C%7C%7C0%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=update_user_profile_info&return_type=json&id=6&other=API_profile_updated%7C%7C%7C%7C1%7C1%7C1%7C%7C%7C%7C%7C0%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set delete_user_profile_info====
+
===set delete_user_profile_info===
 
Borra un perfil de usuario. También elimina todas las asignaciones de ese perfil a cualquier usuario.
 
Borra un perfil de usuario. También elimina todas las asignaciones de ese perfil a cualquier usuario.
  
Line 4,559: Line 4,332:
 
*id=<id del perfil> (obligatorio)  
 
*id=<id del perfil> (obligatorio)  
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_user_profile_info&return_type=json&id=8&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_user_profile_info&return_type=json&id=8&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set create_event_filter====
+
===set create_event_filter===
 
Crea un filtro de evento.
 
Crea un filtro de evento.
  
Line 4,591: Line 4,363:
 
:*<user_comment>
 
:*<user_comment>
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_event_filter&id=test&other=%7C%7Cerror%7C4%7C%7C%7C1%7C%7C12%7C%7C%7C2018-12-09%7C2018-12-13%7C[%226%22]%7C[%2210%22,%226%22,%223%22]%7C1%7C10%7C%7C%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_event_filter&id=test&other=%7C%7Cerror%7C4%7C%7C%7C1%7C%7C12%7C%7C%7C2018-12-09%7C2018-12-13%7C[%226%22]%7C[%2210%22,%226%22,%223%22]%7C1%7C10%7C%7C%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set update_event_filter====
+
===set update_event_filter===
 
Actualiza un filtro de evento.
 
Actualiza un filtro de evento.
  
Line 4,624: Line 4,395:
 
:*<user_comment>
 
:*<user_comment>
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_event_filter&id=195&other=new_name%7C%7C%7Calert_recovered%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_event_filter&id=195&other=new_name%7C%7C%7Calert_recovered%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set delete_event_filter====
+
===set delete_event_filter===
 
Borra un filtro de evento.
 
Borra un filtro de evento.
  
Line 4,636: Line 4,406:
 
*id=<event_filter_id> (obligatorio) debe ser un id de filtro de evento existente.
 
*id=<event_filter_id> (obligatorio) debe ser un id de filtro de evento existente.
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_event_filter&id=38&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_event_filter&id=38&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get all_event_filters====
+
===get all_event_filters===
 
 
 
Devuelve la lista de filtros de eventos existentes.
 
Devuelve la lista de filtros de eventos existentes.
  
Line 4,650: Line 4,418:
 
*other=cvs_separator (opcional)
 
*other=cvs_separator (opcional)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_event_filters&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_event_filters&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set create_inventory_module====
+
===set create_inventory_module===
 
 
 
Crea un nuevo módulo de inventario.
 
Crea un nuevo módulo de inventario.
  
Line 4,671: Line 4,437:
 
:*<modo block>: (obligatorio) 1 o 0.
 
:*<modo block>: (obligatorio) 1 o 0.
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
Este ejemplo crea módulo llamado '''OS''' de inventario que recoge los datos ''kernel-name'' y ''nodename'' de un sistema Linux.
 
Este ejemplo crea módulo llamado '''OS''' de inventario que recoge los datos ''kernel-name'' y ''nodename'' de un sistema Linux.
  
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=create_inventory_module&return_type=json&other=OS%7COS_name_description%7C1%7C/bin/bash%7CIyEvYmluL2Jhc2gKZWNobyB1bmFtZSAtbiAtcw==%7Ckernelname;nodename%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=create_inventory_module&return_type=json&other=OS%7COS_name_description%7C1%7C/bin/bash%7CIyEvYmluL2Jhc2gKZWNobyB1bmFtZSAtbiAtcw==%7Ckernelname;nodename%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set update_inventory_module====
+
===set update_inventory_module===
 
 
 
Actualiza un módulo de inventario.
 
Actualiza un módulo de inventario.
  
Line 4,695: Line 4,459:
 
:*<modo block>: (obligatorio) 1 o 0.
 
:*<modo block>: (obligatorio) 1 o 0.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=update_inventory_module&return_type=json&id=42&other=OS_easy%7COS_name_description%7C1%7C/bin/bash%7CIyEvYmluL2Jhc2gKZWNobyB1bmFtZSAtbiAtcw==%7Ckernelname;nodename%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=update_inventory_module&return_type=json&id=42&other=OS_easy%7COS_name_description%7C1%7C/bin/bash%7CIyEvYmluL2Jhc2gKZWNobyB1bmFtZSAtbiAtcw==%7Ckernelname;nodename%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set delete_inventory_module====
+
===set delete_inventory_module===
 
Borra un perfil de usuario. También elimina todas las asignaciones de ese perfil a cualquier usuario.
 
Borra un perfil de usuario. También elimina todas las asignaciones de ese perfil a cualquier usuario.
  
Line 4,708: Line 4,471:
 
*id=<id del módulo de inventario> (obligatorio)  
 
*id=<id del módulo de inventario> (obligatorio)  
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_inventory_module&return_type=json&id=42&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_inventory_module&return_type=json&id=42&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set create_collection====
+
===set create_collection===
 
Crea una colección.
 
Crea una colección.
  
Line 4,725: Line 4,487:
 
Es necesario acompañarlo con 'other_mode' de la siguiente manera: other_mode=url_encode_separator_&lt;separador&gt; para pasar el separador de los valores serializados de other.
 
Es necesario acompañarlo con 'other_mode' de la siguiente manera: other_mode=url_encode_separator_&lt;separador&gt; para pasar el separador de los valores serializados de other.
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=create_collection&other=test_plugin|test_p|0|test&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=create_collection&other=test_plugin|test_p|0|test&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora</nowiki>
  
====set delete_collection====
+
===set delete_collection===
 
Elimina una colección.
 
Elimina una colección.
  
Line 4,737: Line 4,498:
 
*id= id_collection (obligatorio)
 
*id= id_collection (obligatorio)
  
=====Ejemplos=====
+
====Ejemplos====
 
 
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_collection&id=15&apipass=1234&user=admin&pass=pandora</nowiki>
 
  <nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=delete_collection&id=15&apipass=1234&user=admin&pass=pandora</nowiki>
  
== Ejemplos ==
+
= Ejemplos =
 
 
 
Distintos ejemplos simples de llamada al API en distintos lenguajes.
 
Distintos ejemplos simples de llamada al API en distintos lenguajes.
  
=====Ejemplo=====
+
====Ejemplo====
 
 
 
  <nowiki>http://127.0.0.1/pandora5/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=gis_agent&id=582&other_mode=url_encode_separator_|&other=2%7C2%7C0%7C0%7C0%7C2000-01-01+01%3A01%3A01%7C0%7C666%7Caaa%7Cbbb%7Cccc</nowiki>
 
  <nowiki>http://127.0.0.1/pandora5/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=gis_agent&id=582&other_mode=url_encode_separator_|&other=2%7C2%7C0%7C0%7C0%7C2000-01-01+01%3A01%3A01%7C0%7C666%7Caaa%7Cbbb%7Cccc</nowiki>
  
=== PHP ===
+
== PHP ==
 
<pre>
 
<pre>
 
<?php
 
<?php
Line 4,840: Line 4,598:
 
</pre>
 
</pre>
  
=== Python ===
+
== Python ==
 
<pre>
 
<pre>
 
import pycurl
 
import pycurl
Line 4,908: Line 4,666:
  
  
=== Perl ===
+
== Perl ==
 
<pre>
 
<pre>
 
use strict;
 
use strict;
Line 4,963: Line 4,721:
 
</pre>
 
</pre>
  
=== Ruby ===
+
== Ruby ==
 
<pre>
 
<pre>
 
require 'open-uri'
 
require 'open-uri'
Line 5,019: Line 4,777:
 
</pre>
 
</pre>
  
=== Lua ===
+
== Lua ==
 
<pre>
 
<pre>
 
require("curl")
 
require("curl")
Line 5,088: Line 4,846:
 
</pre>
 
</pre>
  
=== Brainfuck ===
+
== Brainfuck ==
 
<pre>
 
<pre>
 
[-]>[-]<
 
[-]>[-]<
Line 5,171: Line 4,929:
 
</pre>
 
</pre>
  
=== Java (Android) ===
+
== Java (Android) ==
 
Puedes ver nuestro proyecto (Pandroid Event Viewer) en [https://github.com/pandorafms/pandorafms/tree/develop/extras/android-event-viewer Repositorio SVN de Pandroid Event Viewer source code en GitHub] pero aquí esta el trozo de código más importante que realiza la llamada al API para sacar los eventos.
 
Puedes ver nuestro proyecto (Pandroid Event Viewer) en [https://github.com/pandorafms/pandorafms/tree/develop/extras/android-event-viewer Repositorio SVN de Pandroid Event Viewer source code en GitHub] pero aquí esta el trozo de código más importante que realiza la llamada al API para sacar los eventos.
  
Line 5,234: Line 4,992:
 
</pre>
 
</pre>
  
==Futuro del API.php==
+
=Futuro del API.php=
 
 
 
Algunas ideas para el futuro del api.php son:
 
Algunas ideas para el futuro del api.php son:
  

Revision as of 05:46, 3 September 2019

Volver a Indice de Documentacion Pandora FMS

Contents

1 Introducción

La API externa de Pandora FMS se utiliza haciendo llamadas remotas (via HTTP) sobre el fichero /include/api.php. Este es el método que se ha definido en Pandora FMS para integrar aplicaciones de terceros con Pandora FMS. Básicamente consiste en un llamada con los parámetros formateados para recibir un valor o una lista de valores que después su aplicación usará para realizar operaciones.

Una llamada al API.php es tan fácil como:

http://<instalación Pandora Console>/include/api.php<parametros>

El API sólo puede recibir los siguientes parámetros:

  • op (obligatorio): es el primer parámetro. Especifica la naturaleza de la operación que puede ser "get" o "set" o "help:
  • get: devuelve un valor o valores
  • set: envía un valor o valores
  • help: devuelve una pequeña ayuda de las llamadas
  • op2 (obligatorio): la llamada en sí con un nombre explicativo de sobre que actua.
  • id (opcional): primer parámetro de la llamada.
  • id2 (opcional): segundo parámetro de la llamada.
  • other (opcional): tercer parámetro de la llamada, algunas veces puede ser un lista de valores serializados.
  • other_mode (opcional): formato de la serialización. Lista de valores posibles:
  • url_encode: el valor de other es un alfanumérico formateado como UrlEncode.
  • url_encode_separator_<separador>: el valor sera una lista de valores serializados con el carácter separador por ejemplo
...other=peras|melones|sandias&other_mode=url_encode_separator_|
  • returnType (opcional): formato de retorno del valor o valores. Los valores disponibles actuales son:
  • string: devuelve el valor tal cual como un alfanumérico.
  • csv: devuelve los valores como un CSV separado por defecto con el carácter ";" los campos, y separados con retornos de carro las filas.
  • csv_head: devuelve, igual que con "csv", salvo que añade una primera fila con los nombres de los campos a retornar.

2 Seguridad

Actualmente, la seguridad se basa en una lista de IPs que tendrán acceso a la herramienta. Y se podrá configurar como se ve en la imagen, en las opciones de configuración de Pandora Console.

Si se introduce en la caja de texto el carácter * se omite la comprobación de ACL relegando la seguridad al protocolo y al entorno.



Screnshot of api acl list setup.png



También se puede establecer una password para realizar las acciones del API.

Para establecer la password hay que seguir los siguientes pasos:

  • apipass: Password del API que se configura desde la consola. Desde la siguiente vista de configuración (Administration>Setup>):


Api password.png



Nota: Antes de la versión 4.0.2, este parámetro era pass

Para acceder a las acciones de la API, también es necesario proporcionar un usuario y password válidos en el sistema Pandora FMS.

  • user: Usuario de Pandora FMS válido
  • pass: La contraseña del usuario proporcionado

Nota: Las llamadas a la API llevan las contraseñas sin codificar. Por lo que se debería tener cuidado y emplear conexiones SSL para evitar que se puedan ver en la red. La API admite peticiones via POST para poder cifrarlas cuando se usa SSL/HTTPS.

2.1 Retorno

Cuando la API denega el acceso, será devuelta una simple cadena de texto "auth error".

2.2 Ejemplos

En este caso, se está utilizando la password del API 1234 y se está accediendo con el usuario admin y la password pandora.

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=plugins&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

Condiciones de acceso:

  • La IP de origen está en la lista de ACLs
  • La password de la API no está establecida o es 1234
  • El usuario admin existe y su password es pandora

2.3 Workflow del sistema de seguridad

A partir de la versión 4.0.2, la API tiene algunas mejoras en el manejo de la seguridad. Esto se implementa ahora gracias a tres elementos:

  • Filtrado IP. Sólo las IP's listadas podrán acceder a la API.
  • Password global para la API, si se define, es obligatorio usarla en todas las llamadas.
  • Usuario y password válido en la consola. Se utilizarán sus permisos para cada operación solicitada.

Esto se explica en el siguiente workflow:



API access.svg



3 Extensión de nuevas llamadas en el API

Para desarrollar nuevas llamadas para el API tiene que tener en cuenta que:

  • La llamada tiene que estar inscrita como una función en el fichero <instalación Pandora Console>/include/functions_api.php .
  • La función tendrá la siguiente estructura: El prefijo "api", el tipo de llamada "get", "set" o "help" (según si se leen datos, se escriben datos o se obtiene ayuda) y el nombre de la llamada, intentando ser coherente con la operación, por ejemplo: function api_get_[nombre_llamada](parametros) .
  • La función puede no tener parámetros, pero si los tiene, los parámetros recibidos serán los siguientes y en el mismo orden:
  • id: primer operador o parámetro, contiene un string.
  • id2: segundo operador o parámetro, contiene un string.
  • other: resto de operadores o parámetros, contenido como un array de dos posiciones:
  • $other['type']: que puede ser string o array.
  • $other['data']: que será un string con el parámetro o un array de índices numéricos con los parámetros pasados.
  • returnType: string que especifica el tipo de retorno que tendrá la llamada. En principio es transparente para usted, pero puede usarlo o modificarlo si fuese necesario.

3.1 Nuevas llamadas en el API desde las extensiones de Pandora FMS

Es posible crear nuevas llamadas del API sin utilizar /include/functions_api.php. La forma de hacerlo es añadiendo en el directorio de una extensión de Pandora FMS un fichero con el siguiente nombre: <nombre_de_la_extension>.api.php y dentro de este fichero crear las funciones deseadas con las mismas consideraciones de la API estándar pero con el prefijo "apiextension" en lugar de "api".


Por ejemplo, teniendo una extensión llamada "module_groups" con la ruta <instalación de Pandora>/extensions/module_groups debemos crear un fichero llamado module_groups.api.php en este directorio.


En este fichero estarán las funciones deseadas, por ejemplo una función para obtener el número de módulos de un grupo. Esta función debe tener un nombre parecido a: "apiextension_get_groupmodules".

3.1.1 Ejemplo de función

En esta función se han usado funciones imaginarias.

function apiextension_get_groupmodules($group_name) {
    $group_id = group_id_from_name($group_name);
    if($group_id == false) {
       echo 'Group doesnt exist';
       return;
    }

    $number_of_modules = group_modules($group_id);
    echo $number_of_modules;
}

3.1.2 Ejemplo de llamada

En esta llamada se obtiene el número de módulos del grupo "Servers"

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=extension&ext_name=module_groups&ext_function=groupmodules&id=Servers&apipass=1234&user=admin&pass=pandora

3.2 Funciones API

Las siguientes funciones las puede usar en el código de la función de su llamada :

  • returnError(typeError, returnType): devuelve un error de manera uniforme para todas las llamadas.
  • typeError: de momento 'id_not_found' o null.
  • returnType: de momento 'string' o mensaje de error.
  • returnData(returnType, data, separator): es la función que retorna los datos de la llamada del API.
  • returnType: que puede ser 'string', 'csv', 'csv_head'
  • data: es un array que contiene los datos asi como su formato, tiene los siguientes campos:
  • 'type' (obligatorio): que puede ser 'string' y 'array'.
  • 'list_index' (opcional): contiene un array de índices numéricos conteniendo los índices alfanuméricos que se desean sacar por salida.
  • 'data' (obligatorio): contiene o un string con el dato o un array de índice alfanuméricos o numéricos con los datos.

3.3 Ejemplo

function api_get_module_last_value($idAgentModule, $trash1, $other = ';', $returnType)
{
	$sql = sprintf('SELECT datos FROM tagente_estado WHERE id_agente_modulo = %d', $idAgentModule);
	$value = get_db_value_sql($sql);
	if ($value === false) {
		switch ($other['type']) {
			case 'string':
				switch ($other['data']) {
					case 'error_message':
					default:
						returnError('id_not_found', $returnType);
					break;
				}
				break;
			case 'array':
				switch ($other['data'][0]) {
					case 'error_value':
						returnData($returnType, array('type' => 'string', 'data' => $other['data'][1]));
						break;
				}
				break;
		}
	}
	else {
		$data = array('type' => 'string', 'data' => $value);
		returnData($returnType, $data);
	}
}

4 Llamadas al API

Se dividen en dos grupos según si devuelven o escriben datos en Pandora FMS.

Existe una excepción: La llamada de retorno de información.

4.1 RETORNO DE INFORMACIÓN

Devuelve la versión de Pandora Console, de un modo parecido a la función get test pero sin chequear la conexión al API.

Esta llamada es útil para verificar que en esta ruta se encuentra una instalación de Pandora FMS y para obtener la versión antes de la autenticación.

La información que devuelve se puede obtener de la pantalla de login, por lo que no se considera que se vulnere la seguridad.

http://127.0.0.1/pandora_console/include/api.php?info=version

Un ejemplo de respuesta podría ser: Pandora FMS v5.0 - PC131015

4.2 GET

Devuelve los datos solicitados.

4.2.1 get test

Chequea la conexión al API y devuelve la versión del Pandora Console.


Esta característica está en Metaconsola.


Sintaxis de la llamada: Sin parámetros

4.2.1.1 Ejemplos

Este ejemplo devolverá OK,[version],[build]

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=test&apipass=1234&user=admin&pass=pandora

Un ejemplo de respuesta podría ser: OK,v4.0.2,PC120614

4.2.2 get all_agents

Devuelve la lista de agentes filtrados por los filtros seteados en other.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=all_agents (obligatorio)
  • return_type= csv o json (obligatorio)
  • other=<parámetros serializados> (opcional) parámetros para filtrar la búsqueda de agentes, serializados:
  • <filter_so>
  • <filter_group>
  • <filter_module_states>
  • <filter_alias>
  • <filter_policy>
  • <csv_separator>

4.2.2.1 Ejemplos

Este ejemplo devolverá todos los agentes cuyo id_so sea igual a 1, id_group igual a 2, estado de warning, su alias contenga 'j', y su política asociada tenga id igual a 2.

Ejemplo para CSV: http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
Ejemplo para JSON: http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_agents&return_type=json&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.2.3 get module_last_value

Devuelve el último valor de un módulo, el cual se selecciona por el ID pasado por el parámetro id. Con el parámetro other puede añadir el código de error para que tu aplicación detecte este valor fuera del rango de valores del módulo.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=module_last_value (obligatorio)
  • id=<índice> (obligatorio) debe ser un índice de un módulo agente.
  • other=<retorno error> (opcional) que quieres que te devuelva si hay un error (no encontrado en DB el módulo normalmente).
  • Códigos de retorno de error son:
  • 'error_message' devuelve error en un mensaje de texto.
  • 'error_value'<separador><código o valor&gt devuelve ese código o valor de error. Pero es necesario acompañarlo de 'other_mode' tal que así other_mode=url_encode_separator_<separador> para pasar el separador en other.

4.2.3.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_last_value&id=63&other=error_value|0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_last_value&id=62&apipass=1234&user=admin&pass=pandora

4.2.4 get agent_module_name_last_value

Devuelve el último valor de un módulo, el cual se selecciona por nombre del agente pasado por el parámetro id y nombre del módulo pasado por el id2. Con el parámetro other puede añadir el código de error para que tu aplicación detecte este valor fuera del rango de valores que puede ser el módulo.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=agent_module_name_last_value (obligatorio)
  • id=<alfanumerico> (obligatorio) contiene el nombre del agente.
  • id2=<alfanumerico> (obligatorio) contiene el nombre del módulo.
  • other=<retorno error> (opcional) que quieres que te devuelva si hay un error (no encontrado en DB el modulo normalmente).
  • Códigos de retorno de error son:
  • 'error_message' devuelve error en un mensaje de texto.
  • 'error_value'<separador><código o valor&gt devuelve ese código o valor de error. Pero es necesario acompañarlo de 'other_mode' tal que así other_mode=url_encode_separator_<separador> para pasar el separador en other.

4.2.4.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_module_name_last_value&id=user&id2=cpu_user&apipass=1234&user=admin&pass=pandora

4.2.5 get agent_module_name_last_value_alias

>= 7.0NG

Devuelve el último valor de un módulo, el cual se selecciona por alias del agente pasado por el parámetro id y nombre del módulo pasado por el id2. Con el parámetro other puede añadir el código de error para que tu aplicación detecte este valor fuera del rango de valores que puede ser el módulo.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=agent_module_name_last_value_alias (obligatorio)
  • id=<alfanumerico> (obligatorio) contiene el alias del agente.
  • id2=<alfanumerico> (obligatorio) contiene el nombre del modulo.
  • other=<retorno error> (opcional) que quieres que te devuelva si hay un error (no encontrado en DB el módulo normalmente).
  • Códigos de retorno de error son:
  • 'error_message' devuelve error en un mensaje de texto.
  • 'error_value'<separador><código o valor&gt devuelve ese código o valor de error. Pero es necesario acompañarlo de 'other_mode' tal que así other_mode=url_encode_separator_<separador> para pasar el separador en other.

4.2.5.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_module_name_last_value_alias&id=pandorafms&id2=Memory_Used&apipass=1234&user=admin&pass=pandora

4.2.6 get module_value_all_agents

Devuelve una lista de agentes y el valor para el módulo, este módulo lo tienen todos los agentes y es pasado el nombre como parámetro id.


Síntaxis de la llamada:

  • op=get (obligatorio)
  • op2=module_value_all_agents (obligatorio)
  • id=<name of the module> (obligatorio) contiene el nombre del módulo.

4.2.6.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_value_all_agents&id=example_module_name&apipass=1234&user=admin&pass=pandora

4.2.7 get agent_modules

Devuelve la lista de módulos de un agente filtrado por el id del agente pasado como parámetro id.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=agent_modules (obligatorio)
  • return_type=<csv> (obligatorio) Formato de salida.
  • other=<valores serializados> (obligatorio) Valores serializados para filtrar la búsqueda de módulos por agente:
  • <id_agent>

Pero es necesario acompañarlo de 'other_mode' tal que así other_mode=url_encode_separator_<separador> para pasar el separador en other.

4.2.7.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_modules&return_type=csv&other=14&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.2.8 get module_id

Devuelve la id de un módulo concreto de un agente.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=module_id (obligatorio)
  • id= id del agente (obligatorio)
  • other=nombre del modulo (obligatorio)

4.2.8.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_id&id=5&other=Host%20Alive&apipass=1234&user=admin&pass=pandora

4.2.9 get locate_agent

Obtiene el id del servidor donde se encuentra el agente, e imprime todo el resultado como un archivo csv.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=locate_agent (obligatorio)
  • return_type=<csv> (obligatorio) Formato de salida.
  • id=id_agent (obligatorio)
  • other_mode= other_mode=url_encode_separator_<separador&gt (obligatorio)

4.2.9.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=locate_agent&return_type=csv&apipass=1234&user=admin&pass=pandora&id=Pepito&other_mode=url_encode_separator_%7C

4.2.10 get policies

Devuelve la lista políticas de un agente pasado su id dentro del parámetro other.

Síntaxis de llamada:

  • op=get (obligatorio)
  • op2=policies (obligatorio)
  • return_type=<csv> (obligatorio)
  • other=<valores serializados> (opcional) Parámetros serializados para filtrar la búsqueda de políticas por agente:
  • <id_agent>

4.2.10.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=policies&return_type=csv&other=&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.2.11 get tree_agents

Devuelve una completa lista organizada por grupos en el primer nivel, agentes el segundo nivel y módulos el tercer nivel. Esta lista se filtra por el parámetro other.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=tree_agents (obligatorio)
  • return_type=<tipo retorno> (obligatorio) que puede ser 'csv' o 'csv_head'.
  • other=<string o parámetros serializados> (opcional) en este caso puede ser simplemente el separador o una lista de parámetros en orden y separados con el caracter separador, vemos los dos casos:
  • <separador> el separador si del 'csv'
  • <separador csv>|<carácter sustitución de retorno de carro>|<campos 1>,<campos 2>,<campos N> se compondrá de los siguientes parámetros en orden (el carácter '|' de separación se puede especificar en "other_mode"):
  • <separador csv>: separador de los campos en el CSV.
  • <caracter sustitución de retorno de carro>: carácter que sustituirá si encuentra en algún valor devuelto el carácter retorno de carro para evitar la ambigüedad con el uso estándar de retorno de carro para especificar registros/filas en el CSV. Si se pasa un string en other, el carácter sustituto es el espacio en blanco.
  • <campos 1>,<campos 2>,<campos N&gt : los campos a mostrar en el CSV y el orden en que mostrarlos, los posibles campos son:
  • type_row
  • group_id
  • group_name
  • group_parent
  • disabled
  • custom_id
  • group_description
  • group_contact
  • group_other
  • agent_id
  • alias
  • agent_direction
  • agent_comentary
  • agent_id_group
  • agent_last_contant
  • agent_mode
  • agent_interval
  • agent_id_os
  • agent_os_version
  • agent_version
  • agent_last_remote_contact
  • agent_disabled
  • agent_id_parent
  • agent_custom_id
  • agent_server_name
  • agent_cascade_protection
  • agent_name
  • module_id_agent_modulo
  • module_id_agent
  • module_id_module_type
  • module_description
  • module_name
  • module_max
  • module_min
  • module_interval
  • module_tcp_port
  • module_tcp_send
  • module_tcp_rcv
  • module_snmp_community
  • module_snmp_oid
  • module_ip_target
  • module_id_module_group
  • module_flag
  • module_id_module
  • module_disabled
  • module_id_export
  • module_plugin_user
  • module_plugin_pass
  • module_plugin_parameter
  • module_id_plugin
  • module_post_process
  • module_prediction_module
  • module_max_timeout
  • module_custom_id
  • module_history_data
  • module_min_warning
  • module_max_warning
  • module_min_critical
  • module_max_critical
  • module_min_ff_event
  • module_delete_pending
  • module_id_agent_state
  • module_data
  • module_timestamp
  • module_state
  • module_last_try
  • module_utimestamp
  • module_current_interval
  • module_running_by
  • module_last_execution_try
  • module_status_changes
  • module_last_status
  • module_plugin_macros
  • module_macros
  • module_critical_inverse (solo versión 6.0SP1)
  • module_warning_inverse (solo versión 6.0SP1)
  • alert_id_agent_module
  • alert_id_alert_template
  • alert_internal_counter
  • alert_last_fired
  • alert_last_reference
  • alert_times_fired
  • alert_disabled
  • alert_force_execution
  • alert_id_alert_action
  • alert_type
  • alert_value
  • alert_matches_value
  • alert_max_value
  • alert_min_value
  • alert_time_threshold
  • alert_max_alerts
  • alert_min_alerts
  • alert_time_from
  • alert_time_to
  • alert_monday
  • alert_tuesday
  • alert_wednesday
  • alert_thursday
  • alert_friday
  • alert_saturday
  • alert_sunday
  • alert_recovery_notify
  • alert_field2_recovery
  • alert_field3_recovery
  • alert_id_alert_template_module
  • alert_fires_min
  • alert_fires_max
  • alert_id_alert_command
  • alert_command
  • alert_internal
  • alert_template_modules_id
  • alert_templates_id
  • alert_template_module_actions_id
  • alert_actions_id
  • alert_commands_id
  • alert_templates_name
  • alert_actions_name
  • alert_commands_name
  • alert_templates_description
  • alert_commands_description
  • alert_template_modules_priority
  • alert_templates_priority
  • alert_templates_field1
  • alert_actions_field1
  • alert_templates_field2
  • alert_actions_field2
  • alert_templates_field3
  • alert_actions_field3
  • alert_templates_id_group
  • alert_actions_id_group'

4.2.11.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=tree_agents&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=tree_agents&return_type=csv&other=;|%20|type_row,group_id,agent_name&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.2.12 get module_data

Devuelve una lista de valores de un módulo, este módulo se filtra por el id pasado por el parámetro id. Y la lista de valores es desde la fecha actual hasta el límite del periodo pasado como segundo parámetro en el other, el primero es el separador de CSV.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=module_data (obligatorio)
  • id=<id_modulo> (obligatorio)
  • other_mode=url_encode_separator_<separador> (obligatorio)
  • other=<parámetros serializados>(opcional)
  • el carácter de separación del CSV (punto por defecto)
  • el periodo (en segundos)
  • tiempo de inicio (<año><mes><día>T<hora>:<minuto>)
  • tiempo de final (<año><mes><día>T<hora>:<minuto>)

4.2.12.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_data&id=17&other=;|604800|20121201T13:40|20171215T13:40&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.2.13 get graph_module_data

Devuelve la gráfica de un módulo como un fichero de imagen, generada con el método de la gráficas estáticas de Pandora FMS. Es necesario pasar el ancho, alto, periodo, nombre de la gráfica y fecha de comienzo (sabiendo que en Pandora FMS la fecha que se indica en las gráficas siempre es la del final de los datos), pasados todos ellos como other parámetro.


Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=module_data (obligatorio)
  • id=<id_modulo> (obligatorio)
  • other=<parámetros serializados> (obligatorio), son los siguientes en este orden:
  • <period>
  • <width>
  • <height>
  • <label>
  • <start_date>

4.2.13.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=graph_module_data&id=17&other=604800|555|245|example|2009-12-07&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.2.14 get events

Devuelve la lista de eventos filtrados por el parámetro other.


Esta característica está en Metaconsola.


Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=events (obligatorio)
  • return_type=csv (obligatorio)
  • other_mode=url_encode_separator_| (opcional)
  • other=<parámetros serializados> (opcional), son los siguientes en este orden:
  • <separator>
  • <criticity> de 0 a 4, o -1 como valor para evitar el parámetro
  • <agent alias>
  • <module name>
  • <alert template name>
  • <user>
  • <numeric interval minimum level > en formato de tiempo unix
  • <numeric interval maximum level > en formato de tiempo unix
  • <status>
  • <event substring>
  • <register limit>
  • <offset register>
  • <optional style [total|more_criticity]> (total - retorna el total, more_criticity - retorna los de mayor criticidad)
  • <event type> unknown, alert_fired, alert_recovered,.. o subcadena. Puedes usar 'not_normal'.

4.2.14.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=events&return_type=csv&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=events&other_mode=url_encode_separator_|&return_type=csv&other=;|2|SERVER|CPU|template_alert00||1274715715|127471781&apipass=1234&user=admin&pass=pandora

4.2.15 get all_alert_templates

Devuelve la lista de plantillas de alertas definidas en el Pandora FMS.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=all_alert_templates (obligatorio)
  • other=cvs_separator (opcional)

4.2.15.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_alert_templates&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

4.2.16 get module_groups

Devuelve la lista de grupos de módulos.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=module_groups (obligatorio)
  • other=cvs_separator (opcional)

4.2.16.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_groups&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

4.2.17 get plugins

Devuelve la lista de plugins de servidor de Pandora FMS.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=plugins (obligatorio)
  • other=cvs_separator (opcional)

4.2.17.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=plugins&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

4.2.18 get tags

Devuelve la lista de tags definida en Pandora.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=tags (obligatorio)
  • return_type=csv (obligatorio)

4.2.18.1 Ejemplos

Este ejemplo devolverá todos los tags del sistema.

http://localhost/pandora_console/include/api.php?op=get&op2=tags&return_type=csv&apipass=1234&user=admin&pass=pandora

4.2.19 get module_from_conf

>= 5.0 (Sólo Enterprise)

Devuelve la configuración de módulo local.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=update_module_in_conf (obligatorio)
  • id=<id agente> (obligatorio)
  • id2=<nombre módulo> (obligatorio)

4.2.19.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_from_conf&apipass=1234&user=admin&pass=pandora&id=9043&id2=example_name

Si no se encuentra el módulo se retornará cadena vacía

4.2.20 get total_modules

Devuelve el número total de módulos de un grupo.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=total_modules (obligatorio)
  • id=<id grupo> (obligatorio)

4.2.20.1 Ejemplos

http://localhost/pandora_console/include/api.php?op=get&op2=total_modules&id=2&apipass=1234&user=admin&pass=pandora


Si se pone 0 como id de grupo, retornará el número total de módulos.

4.2.21 get total_agents

Devuelve el número total de agentes de un grupo.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=total_agents (obligatorio)
  • id=<id grupo> (obligatorio)

4.2.21.1 Ejemplos

http://localhost/pandora_console/include/api.php?op=get&op2=total_agents&id=2&apipass=1234&user=admin&pass=pandora

4.2.22 get agent_name

Devuelve el nombre de un agente dado su identificador.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=agent_name (obligatorio)
  • id=<id agente> (obligatorio)

4.2.22.1 Ejemplos

http://localhost/pandora_console/include/api.php?op=get&op2=agent_name&id=1&apipass=1234&user=admin&pass=pandora

4.2.23 get agent_alias

>= 7.0NG

Devuelve el alias de un agente dado su identificador.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=agent_alias (obligatorio)
  • id=<id agente> (obligatorio)
  • id2=<id del nodo> (obligatorio en la metaconsola, innecesario en el nodo)

4.2.23.1 Ejemplos

  • Nodo:
http://localhost/pandora_console/include/api.php?op=get&op2=agent_alias&id=1&apipass=1234&user=admin&pass=pandora
  • Metaconsola:
http://localhost/pandora_console/enterprise/meta/include/api.php?op=get&op2=agent_alias&id=1&id2=1&apipass=1234&user=admin&pass=pandoraInsert non-formatted text here

4.2.24 get module_name

Devuelve el nombre de un módulo dado su identificador.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=module_name (obligatorio)
  • id=<id modulo> (obligatorio)

4.2.24.1 Ejemplos

http://localhost/pandora_console/include/api.php?op=get&op2=module_name&id=1&apipass=1234&user=admin&pass=pandora

4.2.25 get alert_action_by_group

Devuelve el total de ejecuciones de alertas con una determinada acción por grupo.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=alert_action_by_group (obligatorio)
  • id=<id grupo> (obligatorio)
  • id2=<id acción> (obligatorio)

4.2.25.1 Ejemplos

http://localhost/pandora_console/include/api.php?op=get&op2=alert_action_by_group&id=0&id2=3&apipass=1234&user=admin&pass=pandora

4.2.26 get alert_actions

Lista acciones de alertas

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=alert_actions (obligatorio)
  • return_type=<tipo retorno> (obligatorio) que puede ser 'csv' o 'json'.
  • other=<parámetros serializados> (opcional):
  • <action_name> (opcional)
  • <separator> (opcional)

4.2.26.1 Ejemplos

http://localhost/pandora_console/include/api.php?op=get&op2=alert_actions&apipass=1234&user=admin&pass=pandora&other=Create|&other_mode=url_encode_separator_|&return_type=json

4.2.27 get alert_actions_meta

Esta característica está en Metaconsola.


Lista acciones de alertas de nodos desde la metaconsola.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=alert_actions_meta (obligatorio)
  • return_type=<tipo retorno> (obligatorio) que puede ser 'csv' o 'json'.
  • other=<parámetros serializados> (opcional):
  • <server_name> (Opcional)
  • <action_name> (opcional)
  • <separator> (opcional)

4.2.27.1 Ejemplos

http://localhost/pandora_console/include/api.php?op=get&op2=alert_actions_meta&apipass=1234&user=admin&pass=pandora&other=nodo|Create|&other_mode=url_encode_separator_|&return_type=json

4.2.28 get all_alert_commands

Devuelve todos los comandos de alertas.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=all_alert_commands (obligatorio)

4.2.28.1 Ejemplos

http://localhost/pandora_console/include/api.php?op=get&op2=all_alert_commands&return_type=csv&other=$&apipass=1234&user=admin&pass=pandora

4.2.29 get event_info

Devuelve toda la información de un evento pasando el id de este evento.


Esta característica está en Metaconsola.


Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=event_info (obligatorio)
  • id=<id_evento> (obligatorio)

4.2.29.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=event_info&id=80&apipass=1234&user=admin&pass=pandora

4.2.30 get tactical_view

Devuelve la siguiente lista de valores (que se puede ver en la página táctica de Pandora Console)

  • monitor_checks
  • monitor_not_init
  • monitor_unknown
  • monitor_ok
  • monitor_bad
  • monitor_warning
  • monitor_critical
  • monitor_not_normal
  • monitor_alerts
  • monitor_alerts_fired
  • monitor_alerts_fire_count
  • total_agents
  • total_alerts
  • total_checks
  • alerts
  • agents_unknown
  • monitor_health
  • alert_level
  • module_sanity
  • server_sanity
  • total_not_init
  • monitor_non_init
  • agent_ok
  • agent_warning
  • agent_critical
  • agent_unknown
  • agent_not_init
  • global_health

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=tactical_view (obligatorio)

4.2.30.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=get&op2=tactical_view&apipass=1234&user=admin&pass=pandora

4.2.31 get pandora_servers

>= 5.0

Devuelve la lista de servidores de Pandora FMS que hay.

call syntax:

  • op=get (obligatorio)
  • op2=pandora_servers (obligatorio)
  • return_type=csv (obligatorio)
  • other=cvs_separator (opcional)

4.2.31.1 Example

http://localhost/pandora_console/include/api.php?op=get&op2=pandora_servers&return_type=csv&apipass=1234&user=admin&pass=pandora

Devuelve los campos en el siguiente orden:

  • nombre
  • estado (1 - arriba, 0 - abajo)
  • tipo (cadena legible por humanos)
  • maestro (1 - maestro 0 - esclavo) ????
  • módulos en ejecución
  • módulos totales
  • max retardo (seg)
  • módulos de retraso
  • hilos
  • módulos en cola
  • fecha y hora de actualización (cadena legible por humanos)

4.2.32 get custom_field_id

>= 5.0

Traduce el nombre de un campo custom al id que tiene en la base de datos.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=custom_field_id (obligatorio)
  • other=<parámetros serializados> (obligatorio) en este caso el nombre del custom field
  • <name> (obligatorio)

4.2.32.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=custom_field_id&other=mycustomfield&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandoraInsert non-formatted text here

4.2.33 get gis_agent

>= 5.0

Devuelve el último valor GIS de un agente.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=gis_agent (obligatorio)
  • id=<índice> (obligatorio) debe ser un índice de un agente.

4.2.33.1 Ejemplo

http://localhost/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=gis_agent&id=1

4.2.34 get special_days

>= 5.1

Devuelve listado de días especiales.

Sintaxis:

  • op=get (obligatorio)
  • op2=special_days (obligatorio)
  • other=<csv separador> (opcional) CSV separador

4.2.34.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?apipass=1111&user=admin&pass=pandora&op=get&op2=special_days

4.2.35 get module_properties

>= 5.1SP2

Devuelve una lista de las propiedades del módulo. La lista podría ser filtrada por el parámetro.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=module_properties (obligatorio)
  • id=<id_modulo> (obligatorio)
  • return_type=<tipo retorno> (obligatorio) que puede ser 'csv' o 'csv_head'.
  • other=<string o parámetros serializados> (opcional) en este caso puede ser simplemente el separador o una lista de parámetros en orden y separados con el carácter separador, vemos los dos casos:
  • <separador> el separador si del 'csv'
  • <separador csv>|<caracter sustitución de retorno de carro>|<campos 1>,<campos 2>,<campos N> se compondra de los siguientes parámetros en orden (el caracter '|' de separación se puede especificar en "other_mode"):
  • <separador csv>: separador de los campos en el CSV.
  • <caracter sustitucion de retorno de carro>: caracter que sustituira si encuentra en algún valor devuelto el carácter retorno de carro para evitar la ambigüedad con el uso estándar de retorno de carro para especificar registros/filas en el CSV. Si se pasa un string en other, el carácter sustituto es el espacio en blanco.
  • <campos 1>,<campos 2>,<campos N&gt : los campos a mostrar en el CSV y el orden en que mostrarlos, los posibles campos son:
  • module_id_agent_modulo
  • module_id_agent
  • module_id_module_type
  • module_description
  • module_name
  • module_max
  • module_min
  • module_interval
  • module_tcp_port
  • module_tcp_send
  • module_tcp_rcv
  • module_snmp_community
  • module_snmp_oid
  • module_ip_target
  • module_id_module_group
  • module_flag
  • module_id_module
  • module_disabled
  • module_id_export
  • module_plugin_user
  • module_plugin_pass
  • module_plugin_parameter
  • module_id_plugin
  • module_post_process
  • module_prediction_module
  • module_max_timeout
  • module_custom_id
  • module_history_data
  • module_min_warning
  • module_max_warning
  • module_min_critical
  • module_max_critical
  • module_min_ff_event
  • module_delete_pending
  • module_id_agent_state
  • module_data
  • module_timestamp
  • module_state
  • module_last_try
  • module_utimestamp
  • module_current_interval
  • module_running_by
  • module_last_execution_try
  • module_status_changes
  • module_last_status
  • module_plugin_macros
  • module_macros
  • module_critical_inverse (solo versión 6.0SP1)
  • module_warning_inverse (solo versión 6.0SP1)

4.2.35.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties&id=6233&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties&id=1103&return_type=csv&other=;|%20|module_id_agent_module,module_id_module_type,module_name,module_last_try,module_state&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.2.36 get module_properties_by_name

>= 5.1SP2

Devuelve una lista de las propiedades del módulo. La lista podria ser filtrada por el parámetro.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=module_properties (obligatorio)
  • id=<nombre agente> (obligatorio)
  • id2=<nombre modulo> (obligatorio)
  • return_type=<tipo retorno> (obligatorio) que puede ser 'csv' o 'csv_head'.
  • other=<string o parametros serializados> (opcional) en este caso puede ser simplemente el separador o una lista de parametros en orden y separados con el caracter separador (el mismo que get_module_properties. para mas detalles, consulte el get_module_properties.

4.2.36.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_name&id=my_agent&id2=my_module&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_name&id=my_agent&id2=my_module&return_type=csv&other=;|%20|module_id_agent_module,module_id_module_type,module_type,module_name,module_last_try,module_state&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.2.37 get module_properties_by_alias

>= 7.0NG

Devuelve una lista de las propiedades del módulo. La lista podria ser filtrada por el parámetro.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=module_properties (obligatorio)
  • id=<alias agente> (obligatorio)
  • id2=<nombre modulo> (obligatorio)
  • return_type=<tipo retorno> (obligatorio) que puede ser 'csv' o 'csv_head'.
  • other=<string o parámetros serializados> (opcional) en este caso puede ser simplemente el separador o una lista de parámetros en orden y separados con el carácter separador (el mismo que get_module_properties. para más detalles, consulte el get_module_properties.

4.2.37.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_alias&id=pandorafms&id2=Memory_Used&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

4.2.38 get module_graph

>= 6.0

Devuelve una gráfica de un módulo codificada con base64.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=module_graph (obligatorio)
  • id=<id del módulo> (obligatorio)
  • other=<período en segundos> (opcional) por defecto 3600 (1 hora). Rango de tiempo en el que se recogerán datos desde la fecha de la petición hacia atrás.

4.2.38.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=get&op2=module_graph&id=5&other=3600%7C1&other_mode=url_encode_separator_%7C&apipass=1234&api=1&user=admin&pass=pandora

4.2.39 get all_planned_downtimes

>= 5.1

Devuelve todas las registros coincidentes de paradas planificadas.

op=get op2=all_planned_downtimes return_type=csv other=<nombre> <id_grupo> <tipo_parada> <tipo ejecución> <tipo de periocidad> (filtros)


4.2.39.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_planned_downtimes&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=json&apipass=1234&user=admin&pass=pandora
 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_planned_downtimes&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=csv&apipass=1234&user=admin&pass=pandora

4.2.40 get planned_downtimes_items

>= 5.1

Retorna todos los objetos de las paradas planificadas que sean coincidentes.

op=get op2=planned_downtimes_items return_type=csv other=<nombre> <grupo> <tipo_parada> <tipo ejecución> <tipo de periocidad>


4.2.40.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=planned_downtimes_items&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=json&apipass=1234&user=admin&pass=pandora
 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=planned_downtimes_items&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=csv&apipass=1234&user=admin&pass=pandora

4.2.41 get id_group_agent_by_name

>= 5.1

Retorna el id de grupo de un agente.

Sintaxis de la llamada:

  • op=get
  • op2=id_group_agent_by_name
  • other=<parámetros serializados> (opcional) parámetros para filtrar, serializados:
  • <nombre_agente>

4.2.41.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=id_group_agent_by_name&other_mode=url_encode_separator_|&other=192.168.50.40

4.2.42 get id_group_agent_by_alias

>= 7.0NG

Retorna el id de grupo de un agente.

Sintaxis de la llamada:

  • op=get
  • op2=id_group_agent_by_alias
  • other=<parámetros serializados> (opcional) parámetros para filtrar, serializados:
  • <alias_agente>

4.2.42.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=id_group_agent_by_alias&other_mode=url_encode_separator_%7C&other=pandorafms

4.2.43 get group_agent_by_name

>= 5.1

Retorna el nombre de grupo de un agente.

Sintaxis de la llamada:

  • op=get
  • op2=group_agent_by_name
  • other=<parámetros serializados> (opcional) parámetros para filtrar, serializados:
  • <nombre_agente>

4.2.43.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_agent_by_name&other_mode=url_encode_separator_|&other=192.168.50.40

4.2.44 get group_agent_by_alias

>= 7.0NG

Retorna el nombre de grupo de un agente.

Sintaxis de la llamada:

  • op=get
  • op2=group_agent_by_alias
  • other=<parámetros serializados> (opcional) parámetros para filtrar, serializados:
  • <alias_agente>

4.2.44.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_agent_by_alias&other_mode=url_encode_separator_%7C&other=pandorafms

4.2.45 get group_id_by_name

>= 7.0NG

Retorna el id de grupo a partir del nombre.

Sintaxis de la llamada:

  • op=get
  • op2=group_id_by_name
  • other=<parámetros único> (obligatorio):
  • <group_name>

4.2.45.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=group_id_by_name&other=Servers

4.2.46 get timezone

>= 7.0NG

Retorna el timezone con el que está configurado Pandora FMS.

Sintaxis de la llamada:

  • op=get
  • op2=timezone

4.2.46.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=timezone

4.2.47 get cluster_status

>= 7.0

Obtener estado del cluster a partir del id

  • op=get
  • op2=cluster_status
  • id=id del cluster
 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_status&id=1&apipass=1234&user=admin&pass=pandora

4.2.48 get cluster_id_by_name

>= 7.0

Obtener id de cluster a partir del nombre

  • op=get
  • op2=cluster_id_by_name
  • id=nombre del cluster
 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_id_by_name&id=paco&apipass=1234&user=admin&pass=pandora

4.2.49 get agents_id_name_by_cluster_id

>= 7.0

Obtener los id => nombres de los agentes del cluster a partir del id de cluster

  • op=get
  • op2=agents_id_name_by_cluster_id
  • id=id del cluster
 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agents_id_name_by_cluster_id&id=1&apipass=1234&user=admin&pass=pandora

4.2.50 get agents_id_name_by_cluster_name

>= 7.0

Obtener los id => nombres de los agentes del cluster a partir del nombre de cluster

  • op=get
  • op2=agents_id_name_by_cluster_name
  • id=id del cluster
 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agents_id_name_by_cluster_name&id=example&apipass=1234&user=admin&pass=pandora

4.2.51 get modules_id_name_by_cluster_id

>= 7.0

Obtener los id => nombres de todos los módulos de los agentes del cluster a partir del id del cluster

  • op=get
  • op2=modules_id_name_by_cluster_id
  • id=id del cluster
 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=modules_id_name_by_cluster_id&id=1&apipass=1234&user=admin&pass=pandora

4.2.52 get modules_id_name_by_cluster_name

>= 7.0

Obtener los id => nombres de todos los módulos de los agentes del cluster a partir del nombre del cluster

  • op=get
  • op2=modules_id_name_by_cluster_name
  • id=id del cluster
 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=modules_id_name_by_cluster_name&id=example&apipass=1234&user=admin&pass=pandora

4.2.53 get cluster_items

>= 7.0

Obtener los items en un objeto json con el formato: id de item => {nombre,id_agente_modulo,type,pcrit,pwarn}, apartir del id del cluster

pcrit: % para estado critico si es AA y 1 o 0 si es AP

pwarn: % para estado warning si es AP y nulo si es AP

  • op=get
  • op2=cluster_items
  • id=id del cluster
 http://127.0.0.1/pandora_console/include/api.php?op=get&op2=cluster_items&id=1&apipass=1234&user=admin&pass=pandora

4.2.54 get policy

>= 7.0NG. 725

Devuelve todos los datos de una política. Si no se especifica un id de política devolverá todos los datos de todas las políticas.

Sintaxis de la llamada:

  • op=get
  • op2=policy
  • id=id_policy (opcional)
  • return_type=(json, csv, string).

4.2.54.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=get&op2=policy&apipass=1234&user=admin&pass=pandora&return_type=json.

4.2.55 get collections_policy

>= 7.0NG. 725

Devuelve todas las colecciones de una política, si no se especifica un id de política devolverá todas las colecciones de todas las políticas.

Sintaxis de la llamada:

  • op=get
  • op2=collections_policy
  • id=id_policy (opcional)
  • return_type=(json, csv, string).

4.2.55.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=get&op2=collections_policy&apipass=1234&user=admin&pass=pandora&return_type=json.

4.2.56 get plugins_policy

>= 7.0NG. 725

Devuelve todas los plugins de una política, si no se especifica un id de política devolverá todos los plugins de todas las políticas.

Sintaxis de la llamada:

  • op=get
  • op2=plugins_policy
  • id=id_policy (opcional)
  • return_type=(json, csv, string).

4.2.56.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=get&op2=plugins_policy&apipass=1234&user=admin&pass=pandora&return_type=json.

4.2.57 get inventory_policy

>= 7.0NG. 725

Devuelve todos los módulos de inventario de una política, si no se especifica un id de política devolverá todos los módulos de inventario de todas las políticas.

Sintaxis de la llamada:

  • op=get
  • op2=inventory_policy
  • id=id_policy (opcional)
  • return_type=(json, csv, string).

4.2.57.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=get&op2=inventory_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2

4.2.58 get unlinking_policy

>= 7.0NG. 725

Devuelve todos los módulos deslincados de una política, si no se especifica un id de política devolverá todos los módulos deslincados de todas las políticas.

Sintaxis de la llamada:

  • op=get
  • op2=unlinking_policy
  • id=id_policy(opcional)
  • return_type=(json, csv, string).

4.2.58.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=get&op2=unlinking_policy&apipass=1234&user=admin&pass=pandora&return_type=json.

4.2.59 get alerts_policy

>= 7.0NG. 725

Devuelve las alertas asociadas a una política teniendo en cuenta:

  • Si se especifica un id de política se mostraran las alertas de dicha política sino se mostrarán las de todas las políticas.
  • Si se especifica el tipo de alerta:(tres opciones).
    • 0: por defecto muestra todas.
    • 1: Muestra solo las alertas normales.
    • 2: Muestra solo las alertas de tipo externo.

Sintaxis de la llamada:

  • op=get
  • op2=alerts_policy
  • id=id_policy(opcional).
  • id2= 0:todas(por defecto), 1:normal, 2:external.
  • return_type=(json, csv, string).

4.2.59.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=get&op2=alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id2=2.

4.2.60 get alerts_actions_policy

>= 7.0NG. 725

Devuelve las acciones de las alertas asociadas a una política teniendo en cuenta:

  • Si se especifica un id de política se mostraran las acciones de las alertas de dicha política sino se mostrarán las de todas las políticas.
  • Si se especifica un id de alerta de política se mostrarán las acciones de dicha alerta especificada.

Sintaxis de la llamada:

  • op = get
  • op2 = alerts_actions_policy
  • id = id_policy(opcional).
  • id2 = id_policy_alert(opcional).
  • return_type=(json, csv, string).

4.2.60.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=get&op2=alerts_actions_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=1&id2=3

4.2.61 get agents_policy

>= 7.0NG. 725

Devuelve todos los agentes que pertenecen a una política, si no se especifica un id de política devolverá todos agentes que pertenecen a todas las políticas.

Sintaxis de la llamada:

  • op = get
  • op2 = agents_policy
  • id = id_policy(opcional)
  • return_type = (json, csv, string).

4.2.61.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=get&op2=agents_policy&apipass=1234&user=admin&pass=pandora&return_type=json.

4.2.62 get groups_policy

>= 7.0NG. 725

Devuelve todos los grupos que pertenecen a una política, si no se especifica un id de política devolverá todos grupos que pertenecen a todas las políticas.

Sintaxis de la llamada:

  • op = get
  • op2 = groups_policy
  • id = id_policy(opcional)
  • return_type = (json, csv, string).

4.2.62.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=get&op2=groups_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2

4.2.63 get queue_policy

>= 7.0NG. 725

Devuelve la cola que pertenecen a una política, si no se especifica un id de política devolverá todas las colas que pertenecen a todas las políticas.

Sintaxis de la llamada:

  • op = get
  • op2 = queue_policy
  • id = id_policy(opcional)
  • return_type = (json, csv, string).

4.2.63.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=get&op2=queue_policy&apipass=1234&user=admin&pass=pandora&return_type=json

4.2.64 get traps

>= 7.0NG. 728

Devuelve los traps de origen especificado, también puedes filtrar por timestamp y otros datos.

Sintaxis de la llamada:

  • op = get
  • op2 = traps
  • other=<parámetros opcionales>:
  • <timestamp>
  • <limit>
  • <offset>
  • <status>
  • <oid_custom>

4.2.64.1 Ejemplo

https://localhost/pandora_console/include/api.php?op=get&op2=traps&other=1537128000%7C9000%7C0%7C1%7C.1.2.3.6.4&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.2.65 get event_responses

Devuelve la lista de respuesta de eventos a las que el usuario tiene acceso en Pandora FMS.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=event_reponses (obligatorio)
  • return_type=csv|json (obligatorio)

4.2.65.1 Ejemplo

Este ejemplo devolverá todas las respuestas de eventos del sistema en formato csv.

http://localhost/pandora_console/include/api.php?op=get&op2=event_responses&return_type=csv&apipass=1234&user=admin&pass=pandora

4.2.66 get users

Devuelve la lista de los usuario de Pandora FMS.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=users (obligatorio)
  • return_type=csv|json (obligatorio)

4.2.66.1 Ejemplo

Este ejemplo devolverá todos usuario del sistema en formato csv.

http://localhost/pandora_console/include/api.php?op=get&op2=users&json&return_type=csv&other_mode=url_encode_separator_&apipass=1234&user=admin&pass=pandora

4.2.67 get list all user

Esta característica está en Metaconsola.


Listar todos los usuarios de Pandora FMS

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=list_all_user (obligatorio)
  • return_type=csv|json (obligatorio)

4.2.67.1 Ejemplo

Puede retornar Json o CSV, este retorno se indica mediante la URL solo se indica el tipo de retorno, no usa ninguna variable en específico

http://localhost/pandora_console/include/api.php?op=get&op2=list_all_user&return_type=json&apipass=1234&user=admin&pass=pandora

4.2.68 get info user name

Esta característica está en Metaconsola.


Lista la informacion de un usuario

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=info_user_name (obligatorio)
  • return_type=csv|json (obligatorio)
  • other=nombre de usuario(obligatorio)

4.2.68.1 Ejemplo

Obtenemos toda la información de un usuario específico Puede retornar Json o CSV, este retorno se indica mediante la URL Usamos unicamente el nombre del usuario para obtener dicha información:

http://localhost/pandora_console/include/api.php?op=get&op2=info_user_name&return_type=json&other=admin&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.2.69 get user_profiles_info

Devuelve la lista de los perfiles de usuario de Pandora FMS.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=user_profiles_info (obligatorio)
  • return_type=csv|json (obligatorio)

4.2.69.1 Ejemplo

Este ejemplo devolverá todos los perfiles de usuario del sistema en formato json.

http://localhost/pandora_console/include/api.php?op=get&op2=user_profiles_info&return_type=json&apipass=1234&user=admin&pass=pandora

4.2.70 get migrate_agent

>= 7.21 ONLY METACONSOLE

Mira si existe en la cola de migración de agentes un agente determinado devolviendo los datos de tmigration_queue

  • op=get
  • op2=migrate_agent
  • id=id_agente a migrar
  • return_type = string, json, etc

4.2.70.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=migrate_agent&apipass=1234&user=admin&pass=pandora&id=2&return_type=json

4.2.71 get language

>= 7.0NG 730

Retorna el idioma con el que está configurado Pandora FMS.

Sintaxis de la llamada:

  • op=get
  • op2=language

4.2.71.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=language

4.2.72 get session_timeout

>= 7.0NG 730

Retorna el tiempo de sesión con el que está configurado Pandora FMS.

Sintaxis de la llamada:

  • op=get
  • op2=session_timeout

4.2.72.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=session_timeout

4.2.73 get groups

Retorna los grupos existentes.

Sintaxis de la llamada:

  • op=get
  • op2=groups
  • other=<parámetros opcionales>:
  • <csv_separator>: ';' por defecto.
  • <return_all_group>: devuelve grupo 'All'.
  • <return_all_columns>: devuelve todas las columnas.

4.2.73.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=groups&other=;%7C1%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.2.74 get filter user group

Esta característica está en Metaconsola.


Obtener grupos de usuario mediante filtrado.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=filter_user_group (obligatorio)
  • return_type=csv|json(obligatorio)
  • other= id group(obligatorio)|Habilitado o no(Disabled)(obligatorio)

4.2.74.1 Ejemplo

Puede retornar Json o CSV, este retorno se indica mediante la URL.

Template warning.png

Puedes tener una de las dos variables (id grupo o Habilitado) vacías, pero tiene que tener mínimo una de ellas.

 


http://localhost/pandora_console/include/api.php?op=get&op2=filter_user_group&return_type=json&other=0|0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.2.75 get inventory_modules

Devuelve la lista de los módulos de inventario de Pandora FMS.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=inventory_modules (obligatorio)
  • return_type=csv|json (obligatorio)

4.2.75.1 Ejemplos

Este ejemplo devolverá información de todos los de inventario del sistema en formato json.

http://localhost/pandora_console/include/api.php?op=get&op2=inventory_modules&return_type=json&apipass=1234&user=admin&pass=pandora

4.2.76 get list_collections

Devuelve la lista de todas las colecciones en Pandora FMS.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=list_collections (obligatorio)

4.2.76.1 Ejemplos

Este ejemplo devolverá información de todos las colecciones en formato json.

http://localhost/pandora_console/include/api.php?op=get&op2=list_collections&apipass=1234&user=admin&pass=pandora

4.2.77 get list_collection_files

Devuelve la lista de todos los ficheros de una colección. Si no se le pasa id de colección, devolverá todos los ficheros de todas las colecciones.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=list_collections_files (obligatorio)
  • id=id_collection

4.2.77.1 Ejemplos

Este ejemplo devolverá los nombres de todos los ficheros de una colección en formato json.

http://localhost/pandora_console/include/api.php?op=get&op2=list_collection_files&id=1&apipass=1234&user=admin&pass=pandora

4.3 SET

Envia los datos.

4.3.1 set new_agent

Crea un nuevo agente con los datos pasados como parámetros.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=new_agent (obligatorio)
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del agente, serializados en el siguiente orden:
  • <alias_agente>
  • <ip>
  • <id_parent>
  • <id_group>
  • <cascade_protection>
  • <cascade_protection_module>
  • <interval_sec>
  • <id_os>
  • <name_server>
  • <custom_id>
  • <learning_mode>
  • <disabled>
  • <description>
  • <alias_as_name>

4.3.1.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_agent&other=agente_alias%7C1.1.1.1%7C0%7C4%7C0%7C0%7C300%7C10%7Cpandorafms%7C8%7C10%7C%7Cla%20descripcion%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
  • Nota: Si alias_as_name es un 1, el nombre del agente será igual al alias. Si es un 0, el nombre del agente se generará automáticamente.

4.3.2 set update_agent

Actualiza el agente con los datos pasados como parámetros.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=new_agent (obligatorio)
  • id=<id_agente> (obligatorio)
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del agente, serializados en el siguiente orden:
  • <alias_agente>
  • <ip>
  • <id_parent>
  • <id_group>
  • <cascade_protection>
  • <cascade_protection_module>
  • <interval_sec>
  • <id_os>
  • <name_server>
  • <custom_id>
  • <learning_mode>
  • <disabled>
  • <description>

4.3.2.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?id=5&op=set&op2=update_agent&other=agente_nombre|1.1.1.1|0|4|0|0|30|8|localhost.localdomain||0|0|la%20descripcion&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.3 set delete_agent

Elimina un agente pasando el nombre como parámetro.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=delete_agent (obligatorio)
  • id=<nombre_agente> (obligatorio) debe ser un nombre agente.

4.3.3.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_agent&id=agente_erroneo&apipass=1234&user=admin&pass=pandora

4.3.4 set create_module_template

Crea una alerta a partir de la plantilla pasada como id, en un módulo elegido por id de módulo y id de agente que estarán en other.

Sintaxis de llamada:

  • op=set (obligatorio)
  • op2=create_module_template (obligatorio)
  • id=<id_template> (obligatorio) debe ser un id de template.
  • other=<id_modulo>|<id_agente>

4.3.4.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_module_template&id=1&other=1|10&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.5 set apply_module_template

Aplicar una plantilla de módulos a un agente..

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.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=apply_module_template (obligatorio)
  • id=<id_template> (obligatorio) id de la plantilla que se aplicará sobre el agente.
  • id2=<id_agente> (obligatorio) id del agente en el que se crearán los módulos.

4.3.5.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_module_template&id=2&id2=2&apipass=1234&user=admin&pass=pandora

4.3.6 set create_network_module

Crea un módulo de red con los datos pasados como parámetros.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=create_network_module (obligatorio)
  • id=<nombre_agente> (obligatorio) debe ser un nombre agente.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
  • <name_module>
  • <disabled>
  • <id_module_type>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <ip_target>
  • <tcp_port>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min_value>
  • <max_value>
  • <custom_id>
  • <description>
  • <enable_unknown_events> (solo versión 5)
  • <module_macros> (solo versión 5) Los valores deben estar en formato JSON codificado en base 64. El formato de los datos del documento JSON debe ser "<nombre de macro>": "<valor de macro>".
  • <each_ff> (solo version 5.1)
  • <ff_threshold_normal> (solo versión 5.1)
  • <ff_threshold_warning> (solo versión 5.1)
  • <ff_threshold_critical> (solo versión 5.1)
  • <critical_inverse> (solo versión 6.0SP1)
  • <warning_inverse> (solo versión 6.0SP1)
  • <ff_type> (solo versión 7.34)

4.3.6.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_network_module&id=example&other=prueba|0|7|1|10|15|0|16|18|0|15|0|127.0.0.1|0||0|180|0|0|0|0|latency%20ping&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.7 set create_plugin_module

Crea un módulo de tipo plugin con los datos pasados como parámetros.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=create_plugin_module (obligatorio)
  • id=<nombre_agente> (obligatorio) debe ser un nombre agente.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del módulo, serializados en el siguiente orden:
  • <name_module>
  • <disabled>
  • <id_module_type>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <ip_target>
  • <tcp_port>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min_value>
  • <max_value>
  • <custom_id>
  • <description>
  • <id_plugin>
  • <plugin_user>
  • <plugin_pass>
  • <plugin_parameter>
  • <enable_unknown_events> (solo versión 5)
  • <macros> (solo versión 5) Los valores deben estar en formato JSON codificado en base 64. El contenido del documento JSON debe ser un objeto compuesto de varios objetos con las siguientes propiedades:
    • "macro": Nombre del macro. Deben ser _field1_, _field2_, ..., _fieldN_.
    • "desc": Nombre descriptivo del macro.
    • "help": Descripción del macro.
    • "value": Valor del macro.
    • "hide": Poner a "1" para ocultar el valor del macro (útil para almacenar contraseñas).

4.3.7.1 Ejemplo

{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1",
   "hide": ""
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80",
   "hide": ""
 }
}
  • <module_macros> (solo versión 5) Los valores deben estar en formato JSON codificado en base 64. El formato de los datos del documento JSON debe ser "<nombre de macro>": "<valor de macro>".
  • <each_ff> (solo versión 5.1)
  • <ff_threshold_normal> (solo versión 5.1)
  • <ff_threshold_warning> (solo versión 5.1)
  • <ff_threshold_critical> (solo versión 5.1)
  • <critical_inverse> (solo versión 6.0SP1)
  • <warning_inverse> (solo versión 6.0SP1)
  • <ff_type> (solo versión 734)

4.3.7.2 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_plugin_module&id=example&other=prueba|0|1|2|0|0||0|0||0|0|127.0.0.1|0||0|300|0|0|0|0|plugin%20module%20from%20api|4|2|admin|pass|-p%20max&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.8 set create_data_module

Crea un módulo con los parámetros pasados.

Template warning.png

Con esta llamada se puede añadir datos al módulo en la base de datos, pero no se puede modificar el fichero de configuración de los agentes asociados al módulo

 


Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=create_data_module (obligatorio)
  • id=<nombre_agente> (obligatorio) debe ser un nombre agente.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del módulo, serializados en el siguiente orden:
  • <name_module>
  • <disabled>
  • <id_module_type>
  • <description>
  • <id_module_group>
  • <min_value>
  • <max_value>
  • <post_process>
  • <module_interval>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <history_data>
  • <enable_unknown_events> (solo versión 5)
  • <module_macros> (solo versión 5) Los valores deben estar en formato JSON codificado en base 64. El formato de los datos del documento JSON debe ser "<nombre de macro>": "<valor de macro>".
  • <ff_threshold> (solo versión 5.1)
  • <each_ff> (solo versión 5.1)
  • <ff_threshold_normal> (solo versión 5.1)
  • <ff_threshold_warning> (solo versión 5.1)
  • <ff_threshold_critical> (solo versión 5.1)
  • <ff_timeout> (solo versión 5.1)
  • <critical_inverse> (solo versión 6.0SP1)
  • <warning_inverse> (solo versión 6.0SP1)
  • <ff_type> (solo versión 734)

4.3.8.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_data_module&id=example&other=prueba|0|1|data%20module%20from%20api|1|10|20|10.50|180|10|15||16|20||0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.9 set create_SNMP_module

Crea un módulo SNMP.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=create_snmp_module (obligatorio)
  • id=<nombre_agente> (obligatorio) debe ser un nombre agente.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del módulo, serializados en el siguiente orden:
  • <name_module>
  • <disabled>
  • <id_module_type>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <ip_target>
  • <module_port>
  • <snmp_version>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min_value>
  • <max_value>
  • <custom_id>
  • <description>
  • <snmp3_priv_method [AES|DES]>
  • <snmp3_priv_pass>
  • <snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv]>
  • <snmp3_auth_method [MD5|SHA]>
  • <snmp3_auth_user>
  • <snmp3_auth_pass>
  • <enable_unknown_events> (solo versión 5)
  • <each_ff> (solo versión 5.1)
  • <ff_threshold_normal> (solo versión 5.1)
  • <ff_threshold_warning> (solo versión 5.1)
  • <ff_threshold_critical> (solo versión 5.1)
  • <ff_type> (solo versión 734)

4.3.9.1 Ejemplos

Ejemplo 1 (snmp v: 3, snmp3_priv_method: AES, snmp3_priv_pass: example_priv_passw, snmp3_sec_level: authNoPriv, snmp3_auth_method:MD5, snmp3_auth_user: pepito_user, snmp3_auth_pass: example_priv_passw)

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_snmp_module&id=example&other=prueba|0|15|1|10|15||16|18||15|0|127.0.0.1|60|3|public|.1.3.6.1.2.1.1.1.0|180|0|0|0|0|SNMP%20module%20from%20API|AES|example_priv_passw|authNoPriv|MD5|pepito_user|example_auth_passw&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Ejemplo 2 (snmp v: 1)

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_snmp_module&id=pepito1&other=prueba2|0|15|1|10|15||16|18||15|0|127.0.0.1|60|1|public|.1.3.6.1.2.1.1.1.0|180|0|0|0|0|SNMP module from API&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.10 set update_network_module

Actualiza la configuración de un módulo de red.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=update_network_module (obligatorio)
  • id=<id_modulo> (obligatorio) debe ser el ID numérico del módulo (tagente_modulo)
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
  • <id_agent>
  • <disabled>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <ip_target>
  • <tcp_port>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min_value>
  • <max_value>
  • <custom_id>
  • <description>
  • <disabled_types_event> (solo versión 5)
  • <module_macros> (solo versión 5) Los valores deben estar en formato JSON codificado en base 64. El formato de los datos del documento JSON debe ser "<nombre de macro>": "<valor de macro>".
  • <each_ff> (solo versión 5.1)
  • <ff_threshold_normal> (solo versión 5.1)
  • <ff_threshold_warning> (solo versión 5.1)
  • <ff_threshold_critical> (solo versión 5.1)
  • <critical_inverse> (solo versión 6.0SP1)
  • <warning_inverse> (solo versión 6.0SP1)
  • <ff_type> (solo versión 733)

4.3.10.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_network_module&id=3431&other=44|0|6|2|10|15||16|18||7|0|127.0.0.1|0||0|300|30.00|0|0|0|latency%20ping%20modified%20by%20the%20Api&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.11 set update_plugin_module

Actualiza la configuración de un módulo plugin.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=update_plugin_module (obligatorio)
  • id=<nombre_modulo> (obligatorio) debe ser el ID numérico del módulo a actualizar (tagente_modulo)
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del módulo, serializados en el siguiente orden:
  • <id_agent>
  • <disabled>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <ip_target>
  • <tcp_port>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min_value>
  • <max_value>
  • <custom_id>
  • <description>
  • <id_plugin>
  • <plugin_user>
  • <plugin_pass>
  • <plugin_parameter>
  • <disabled_types_event> (solo versión 5)
  • <macros> (solo versión 5) Los valores deben estar en formato JSON codificado en base 64. El contenido del documento JSON debe ser un objeto compuesto de varios objetos con las siguientes propiedades:
    • "macro": Nombre del macro. Deben ser _field1_, _field2_, ..., _fieldN_.
    • "desc": Nombre descriptivo del macro.
    • "help": Descripción del macro.
    • "value": Valor del macro.

4.3.11.1 Ejemplo

{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1"
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80"
 }
}
  • <module_macros> (solo versión 5) Los valores deben estar en formato JSON codificado en base 64. El formato de los datos del documento JSON debe ser "<nombre de macro>": "<valor de macro>".
  • <each_ff> (solo versión 5.1)
  • <ff_threshold_normal> (solo versión 5.1)
  • <ff_threshold_warning> (solo versión 5.1)
  • <ff_threshold_critical> (solo versión 5.1)
  • <critical_inverse> (solo versión 6.0SP1)
  • <warning_inverse> (solo versión 6.0SP1)
  • <ff_type> (solo versión 734)

4.3.11.2 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_plugin_module&id=2343&other=44|0|2|0|0||0|0||0|0|127.0.0.1|0||0|300|0|0|0|0|plugin%20module%20from%20api|2|admin|pass|-p%20max&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.12 set update_data_module


Template warning.png

Con esta llamada se puede añadir datos al módulo en la base de datos, pero no se puede modificar el fichero de configuración de los agentes asociados al módulo

 


Actualiza un módulo local.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=update_data_module_policy (obligatorio)
  • id=<id_agent_module> (obligatorio) debe ser el ID numérico del módulo a actualizar.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del módulo, serializados en el siguiente orden:
  • <id_agent>
  • <disabled>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <ip_target>
  • <module_port>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min_value>
  • <max_value>
  • <custom_id>
  • <description>
  • <disabled_types_event> (solo versión 5)
  • <module_macros> (solo versión 5) Los valores deben estar en formato JSON codificado en base 64. El formato de los datos del documento JSON debe ser "<nombre de macro>": "<valor de macro>".
  • <ff_threshold> (solo versión 5.1)
  • <each_ff> (solo versión 5.1)
  • <ff_threshold_normal> (solo versión 5.1)
  • <ff_threshold_warning> (solo versión 5.1)
  • <ff_threshold_critical> (solo versión 5.1)
  • <ff_timeout> (solo versión 5.1)
  • <critical_inverse> (solo versión 6.0SP1)
  • <warning_inverse> (solo versión 6.0SP1)
  • <ff_type> (solo versión 734)

4.3.12.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_data_module&id=23234&other=44|0|data%20module%20modified%20from%20API|6|0|0|50.00|300|10|15||16|18||0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.13 set update_data_module_policy

Actualiza el módulo de datos de una política y devuelve el id del nuevo módulo.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=update_data_module (obligatorio)
  • id=<id_agent_module> (obligatorio) debe ser el ID numérico de la política del módulo.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del módulo, serializados en el siguiente orden:
  • <id_policy_module>
  • <description>
  • <id_module_group>
  • <min>
  • <max>
  • <post_process>
  • <module_interval>
  • <min_warning>
  • <max_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <history_data>
  • <configuration_data>
  • <disabled_types_event> (solo versión 5)
  • <module_macros> (solo versión 5) Los valores deben estar en formato JSON codificado en base 64. El formato de los datos del documento JSON debe ser "<nombre de macro>": "<valor de macro>".

4.3.13.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_data_module_policy&id=1&other=10~data%20module%20updated%20by%20Api~2~0~0~50.00~10~20~180~~21~35~~1~module_begin%0dmodule_name%20pandora_process%0dmodule_type%20generic_data%0dmodule_exec%20ps%20aux%20|%20grep%20pandora%20|%20wc%20-l%0dmodule_end&other_mode=url_encode_separator_

4.3.14 set update_SNMP_module

Actualiza un módulo SNMP.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=update_snmp_module (obligatorio)
  • id=<id_module> (obligatorio) debe ser un ID numérico de módulo.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
  • <id_agent>
  • <disabled>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <ip_target>
  • <module_port>
  • <snmp_version>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min_value>
  • <max_value>
  • <custom_id>
  • <description>
  • <snmp3_priv_method [AES|DES]>
  • <snmp3_priv_pass>
  • <snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv]>
  • <snmp3_auth_method [MD5|SHA]>
  • <snmp3_auth_user>
  • <snmp3_auth_pass>
  • <disabled_types_event> (solo versión 5)
  • <each_ff> (solo versión 5.1)
  • <ff_threshold_normal> (solo versión 5.1)
  • <ff_threshold_warning> (solo versión 5.1)
  • <ff_threshold_critical> (solo versión 5.1)
  • <policy_linked> (solo versión 6.1)
  • <ff_type> (solo versión 734)

4.3.14.1 Ejemplos

Example (snmp v: 3, snmp3_priv_method: AES, snmp3_priv_pass: example_priv_passw, snmp3_sec_level: authNoPriv, snmp3_auth_method:MD5, snmp3_auth_user: pepito_user, snmp3_auth_pass: example_priv_passw)

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_snmp_module&id=33432&other=44|0|6|20|25||26|30||15|1|127.0.0.1|60|3|public|.1.3.6.1.2.1.1.1.0|180|50.00|10|60|0|SNMP%20module%20modified%20by%20API|AES|example_priv_passw|authNoPriv|MD5|example_user|example_auth_passw&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.15 set apply_policy

Aplica la política, pasada por id, en uno o varios agentes.

Sintaxis de la llamada:

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

4.3.15.1 Ejemplos

http://192.168.70.102/pandora_console/include/api.php?op=set&op2=apply_policy&id=22&id2=3e&other=0|1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.16 set apply_all_policies

Aplica todas las políticas que contiene Pandora.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=apply_all_policies (obligatorio)

4.3.16.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_all_policies&apipass=1234&user=admin&pass=pandora

4.3.17 set add_network_module_policy

Añade un módulo de red en la política pasada por id en el parámetro.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=add_network_module_policy (obligatorio)
  • id=<id_politica> (obligatorio) debe ser un Id de política
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
  • <name_module>
  • <id_module_type>
  • <description>
  • <id_module_group>
  • <min_value>
  • <max_value>
  • <post_process>
  • <module_interval>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <history_data>
  • <ff_threshold>
  • <disabled>
  • <module_port>
  • <snmp_community>
  • <snmp_oid>
  • <custom_id>
  • <enable_unknown_events> (solo versión 5)
  • <module_macros> (solo versión 5) Los valores deben estar en formato JSON codificado en base 64. El formato de los datos del documento JSON debe ser "<nombre de macro>": "<valor de macro>".
  • <each_ff> (solo versión 5.1)
  • <ff_threshold_normal> (solo versión 5.1)
  • <ff_threshold_warning> (solo versión 5.1)
  • <ff_threshold_critical> (solo versión 5.1)
  • <ff_type> (solo versión 734)

4.3.17.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_network_module_policy&id=1&other=network_module_policy_example_name|6|network%20module%20created%20by%20Api|2|0|0|50.00|180|10|20||21|35||1|15|0|66|||0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.18 set add_plugin_module_policy

Añade un módulo de plugin en la política pasada por id en el parámetro.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=add_plugin_module_policy (obligatorio)
  • id=<id_politica> (obligatorio) debe ser un Id de política.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
  • <name_module>
  • <disabled>
  • <id_module_type>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <module_port>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min_value>
  • <max_value>
  • <custom_id>
  • <description>
  • <id_plugin>
  • <plugin_user>
  • <plugin_pass>
  • <plugin_parameter>
  • <enable_unknown_events> (solo versión 5)
  • <macros> (solo versión 5) Los valores deben estar en formato JSON codificado en base 64. El contenido del documento JSON debe ser un objeto compuesto de varios objetos con las siguientes propiedades:
    • "macro": Nombre del macro. Deben ser _field1_, _field2_, ..., _fieldN_.
    • "desc": Nombre descriptivo del macro.
    • "help": Descripción del macro.
    • "value": Valor del macro.

4.3.18.1 Ejemplo

{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1"
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80"
 }
}
  • <module_macros> (solo versión 5) Los valores deben estar en formato JSON codificado en base 64. El formato de los datos del documento JSON debe ser "<nombre de macro>": "<valor de macro>".
  • <each_ff> (solo versión 5.1)
  • <ff_threshold_normal> (solo versión 5.1)
  • <ff_threshold_warning> (solo versión 5.1)
  • <ff_threshold_critical> (solo versión 5.1)
  • <ff_type> (solo versión 734)

4.3.18.2 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_plugin_module_policy&id=1&other=example%20plugin%20module%20name|0|1|2|0|0||0|0||15|0|66|||300|50.00|0|0|0|plugin%20module%20from%20api|2|admin|pass|-p%20max&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.19 set add_data_module_policy

Añade un módulo local en la política pasada por id en el parámetro.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=add_data_module_policy (obligatorio)
  • id=<id_política> (obligatorio) debe ser un Id de política.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del módulo, serializados en el siguiente orden:
  • <name_module>
  • <id_module_type>
  • <description>
  • <id_module_group>
  • <min_value>
  • <max_value>
  • <post_process>
  • <module_interval>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <history_data>
  • <configuration_data> Este es el bloque de definición del módulo que será insertado en el fichero de configuración del agente.
  • <enable_unknown_events> (solo versión 5)
  • <module_macros> (solo versión 5) Los valores deben estar en formato JSON codificado en base 64. El formato de los datos del documento JSON debe ser "<nombre de macro>": "<valor de macro>".
  • <ff_threshold> (solo versión 5.1)
  • <each_ff> (solo versión 5.1)
  • <ff_threshold_normal> (solo versión 5.1)
  • <ff_threshold_warning> (solo versión 5.1)
  • <ff_threshold_critical> (solo versión 5.1)
  • <ff_timeout> (solo versión 5.1)
  • <ff_type> (solo versión 734)

4.3.19.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_data_module_policy&id=1&other=data_module_policy_example_name~2~data%20module%20created%20by%20Api~2~0~0~50.00~10~20~180~~21~35~~1~module_begin%0dmodule_name%20pandora_process%0dmodule_type%20generic_data%0dmodule_exec%20ps%20aux%20|%20grep%20pandora%20|%20wc%20-l%0dmodule_end&other_mode=url_encode_separator_~&apipass=1234&user=admin&pass=pandora

4.3.20 set add_SNMP_module_policy

Añade un módulo SNMP en la política pasada por id en el parámetro.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=add_snmp_module_policy (obligatorio)
  • id=<id_política> (obligatorio) debe ser un Id de política.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
  • <name_module>
  • <disabled>
  • <id_module_type>
  • <id_module_group>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <history_data>
  • <module_port>
  • <snmp_version>
  • <snmp_community>
  • <snmp_oid>
  • <module_interval>
  • <post_process>
  • <min_value>
  • <max_value>
  • <custom_id>
  • <description>
  • <snmp3_priv_method [AES|DES]>
  • <snmp3_priv_pass>
  • <snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv]>
  • <snmp3_auth_method [MD5|SHA]>
  • <snmp3_auth_user>
  • <snmp3_auth_pass>
  • <enable_unknown_events> (solo versión 5)
  • <each_ff> (solo versión 5.1)
  • <ff_threshold_normal> (solo versión 5.1)
  • <ff_threshold_warning> (solo versión 5.1)
  • <ff_threshold_critical> (solo versión 5.1)
  • <ff_type> (solo versión 734)

4.3.20.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_snmp_module_policy&id=1&other=example%20SNMP%20module%20name|0|15|2|0|0||0|0||15|1|66|3|public|.1.3.6.1.2.1.1.1.0|180|50.00|10|60|0|SNMP%20module%20modified%20by%20API|AES|example_priv_passw|authNoPriv|MD5|example_user|example_auth_passw&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.21 set add_agent_policy_by_id

Añade un agente en una política utilizando el ID de agente.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=add_agent_policy_by_id (obligatorio)
  • id=<id_política> (obligatorio) debe ser un Id de política.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del agente, serializados en el siguiente orden:
  • <id_agent>
  • <id_node> (obligatorio en caso de usar Metaconsola) ID del nodo al que pertenece el agente que deseamos añadir a la política.

4.3.21.1 Ejemplos

  • Nodo:
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_id&id=2&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
  • Metaconsola:
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_id&id=2&other=1%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.22 set add_agent_policy_by_name

Añade un agente en una política utilizando el nombre de agente.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=add_agent_policy_by_name (obligatorio)
  • id=<id_política> (obligatorio) debe ser un Id de política.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del agente, serializados en el siguiente orden:
  • <agent_name>

4.3.22.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy_by_name&id=4&other=e76774025b24057cc71df514f27027c43484c3af766ed40f259a86a4fd568f9d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.23 set remove_agent_from_policy_by_id

Elimina un agente de una política utilizando el ID de agente.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=remove_agent_from_policy_by_id (obligatorio)
  • id=<id_política> (obligatorio) debe ser un Id de política.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del agente, serializados en el siguiente orden:
  • <id_agent>
  • <id_node> (obligatorio en caso de usar Metaconsola) ID del nodo al que pertenece el agente que deseamos eliminar de la política.

4.3.23.1 Ejemplos

  • Nodo:
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_id&id=2&other=2&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
  • Metaconsola:
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_id&id=4&other=1%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.24 set remove_agent_from_policy_by_name

Elimina un agente de una política utilizando el nombre de agente.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=remove_agent_from_policy_by_name (obligatorio)
  • id=<id_política> (obligatorio) debe ser un Id de política.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del agente, serializados en el siguiente orden:
  • <agent_name>

4.3.24.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_agent_from_policy_by_name&id=4&other=e76774025b24057cc71df514f27027c43484c3af766ed40f259a86a4fd568f9d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.25 set new_network_component

Crea un nuevo componente de red.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=new_network_component (obligatorio)
  • id=<network_component_name> (obligatorio) debe ser el nombre del componente de red.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del componente de red, serializados en el siguiente orden:
  • <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>
  • <ff_threshold>
  • <post_process>
  • <network_component_group>
  • <enable_unknown_events> (solo versión 5)
  • <each_ff> (solo versión 5.1)
  • <ff_threshold_normal> (solo versión 5.1)
  • <ff_threshold_warning> (solo versión 5.1)
  • <ff_threshold_critical> (solo versión 5.1)
  • <ff_type> (solo versión 734)


4.3.25.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_network_component&id=example_network_component_name&other=7|network%20component%20created%20by%20Api|300|30|10|public|3||1|10|20|str|21|30|str1|10|50.00|12&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.26 set new_plugin_component

Crea un nuevo componente de plugin.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=new_plugin_component (obligatorio)
  • id=<plugin_component_name> (obligatorio) debe ser el nombre del componente de tipo plugin.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del componente de tipo plugin, serializados en el siguiente orden:
  • <plugin_component_type>
  • <description>
  • <module_interval>
  • <max_value>
  • <min_value>
  • <module_port>
  • <id_module_group>
  • <id_plugin>
  • <max_timeout>
  • <history_data>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <post_process>
  • <plugin_component_group>
  • <enable_unknown_events> (solo versión 5)
  • <each_ff> (solo versión 5.1)
  • <ff_threshold_normal> (solo versión 5.1)
  • <ff_threshold_warning> (solo versión 5.1)
  • <ff_threshold_critical> (solo versión 5.1)
  • <ff_type> (solo versión 734)

4.3.26.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_plugin_component&id=example_plugin_component_name&other=2|plugin%20component%20created%20by%20Api|300|30|10|66|3|2|example_user|example_pass|-p%20max||1|10|20|str|21|30|str1|10|50.00|12&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.27 set new_snmp_component

Crea un nuevo componente de SNMP.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=new_snmp_component (obligatorio)
  • id=<snmp_component_name> (obligatorio) debe ser el nombre del componente de tipo snmp.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del componente de tipo snmp, serializados en el siguiente orden:
  • <snmp_component_type>
  • <description>
  • <module_interval>
  • <max_value>
  • <min_value>
  • <id_module_group>
  • <max_timeout>
  • <history_data>
  • <min_warning>
  • <max_warning>
  • <str_warning>
  • <min_critical>
  • <max_critical>
  • <str_critical>
  • <ff_threshold>
  • <post_process>
  • <snmp_version>
  • <snmp_oid>
  • <snmp_community>
  • <snmp3_auth_user>
  • <snmp3_auth_pass>
  • <module_port>
  • <snmp3_privacy_method>
  • <snmp3_privacy_pass>
  • <snmp3_auth_method>
  • <snmp3_security_level>
  • <snmp_component_group>
  • <enable_unknown_events> (solo versión 5)
  • <each_ff> (solo versión 5.1)
  • <ff_threshold_normal> (solo versión 5.1)
  • <ff_threshold_warning> (solo versión 5.1)
  • <ff_threshold_critical> (solo versión 5.1)
  • <ff_type> (solo versión 734)


4.3.27.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_snmp_component&id=example_snmp_component_name&other=16|SNMP%20component%20created%20by%20Api|300|30|10|3||1|10|20|str|21|30|str1|15|50.00|3|.1.3.6.1.2.1.2.2.1.8.2|public|example_auth_user|example_auth_pass|66|AES|example_priv_pass|MD5|authNoPriv|12&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.28 set new_local_component

Crea un nuevo componente local.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=new_local_component (obligatorio)
  • id=<local_component_name> (obligatorio) debe ser el nombre del componente de tipo local.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del componente de tipo local, serializados en el siguiente orden:
  • <description>
  • <id_os>
  • <local_component_group>
  • <configuration_data> Este es el bloque de configuración de un módulo.
  • <enable_unknown_events> (solo versión 5)
  • <ff_threshold> (solo versión 5.1)
  • <each_ff> (solo versión 5.1)
  • <ff_threshold_normal> (solo versión 5.1)
  • <ff_threshold_warning> (solo versión 5.1)
  • <ff_threshold_critical> (solo versión 5.1)
  • <ff_timeout> (solo versión 5.1)
  • <ff_type> (solo versión 734)

4.3.28.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_local_component&id=example_local_component_name&other=local%20component%20created%20by%20Api~5~12~module_begin%0dmodule_name%20example_local_component_name%0dmodule_type%20generic_data%0dmodule_exec%20ps%20|%20grep%20pid%20|%20wc%20-l%0dmodule_interval%202%0dmodule_end&other_mode=url_encode_separator_~&apipass=1234&user=admin&pass=pandora

4.3.29 set create_alert_template

Crea una plantilla de alerta.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=create_alert_template (obligatorio)
  • id=<template_name> (obligatorio) el nombre de la plantilla.
  • other=<serialized parameters> (obligatorio) las configuraciones y datos de la plantilla, serializados en el siguiente orden:
  • <type [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]>
  • <description>
  • <id_alert_action>
  • <field1>
  • <field2>
  • <field3>
  • <value>
  • <matches_value>
  • <max_value>
  • <min_value>
  • <time_threshold>
  • <max_alerts>
  • <min_alerts>
  • <time_from>
  • <time_to>
  • <monday>
  • <tuesday>
  • <wednesday>
  • <thursday>
  • <friday>
  • <saturday>
  • <sunday>
  • <recovery_notify>
  • <field2_recovery>
  • <field3_recovery>
  • <priority>
  • <id_group>

4.3.29.1 Ejemplos

Ejemplo 1 (condition: regexp =~ /pp/, action: Mail to XXX, max_alert: 10, min_alert: 0, priority: WARNING, group: databases):

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_alert_template&id=example&other=regex|template%20based%20in%20regexp|1||||pp|1||||10|0|||||||||||||3&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Ejemplo 2 (condition: value is not between 5 and 10, max_value: 10.00, min_value: 5.00, time_from: 00:00:00, time_to: 15:00:00, priority: CRITICAL, group: Servers):

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_alert_template&id=template_min_max&other=max_min|template%20based%20in%20range|NULL||||||10|5||||00:00:00|15:00:00|||||||||||4|2&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.30 set update_alert_template

Actualiza una plantilla de alerta.

Sintaxis de llamada:

  • op=set (obligatorio)
  • op2=update_alert_template (obligatorio)
  • id=<id_template> (obligatorio) debe ser un id de template.
  • other=<serializar parámetros> (oligatorio) son los datos de configuration del template, serializados en este orden:
  • <template_name>
  • <type [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]>
  • <description>
  • <id_alert_action>
  • <field1>
  • <field2>
  • <field3>
  • <value>
  • <matches_value>
  • <max_value>
  • <min_value>
  • <time_threshold>
  • <max_alerts>
  • <min_alerts>
  • <time_from>
  • <time_to>
  • <monday>
  • <tuesday>
  • <wednesday>
  • <thursday>
  • <friday>
  • <saturday>
  • <sunday>
  • <recovery_notify>
  • <field2_recovery>
  • <field3_recovery>
  • <priority>
  • <id_group>

4.3.30.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_alert_template&id=38&other=example_template_with_changed_name|onchange|changing%20from%20min_max%20to%20onchange||||||1||||5|1|||1|1|0|1|1|0|0|1|field%20recovery%20example%201|field%20recovery%20example%202|1|8&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.31 set delete_alert_template

Borra una plantilla de alerta y todas las alertas definidas por ella.

Sintaxis de llamada:

  • op=set (oligatorio)
  • op2=delete_alert_template (obligatorio)
  • id=<id_template> (obligatorio) debe ser un id de template.

4.3.31.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_alert_template&id=38&apipass=1234&user=admin&pass=pandora

4.3.32 set delete_module_template

Borra una plantilla de módulos.

Sintaxis de llamada:

  • op=set (obligatorio)
  • op2=delete_module_template (obligatorio)
  • id=<id_alert_template_module> (obligatorio) debe ser un id de alert_template_module.

4.3.32.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module_template&id=38&apipass=1234&user=admin&pass=pandora

4.3.33 set delete_module_template_by_names

Borra una plantilla de módulos.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=new_alert_template (obligatorio)
  • id=<nombre del agente> (obligatorio)
  • id2=<nombre de la plantilla de alerta> (obligatorio)
  • other=<parametros serializados> (obligatorio), son los siguientes en este orden:
  • <nombre modulo> (obligatorio)

4.3.33.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module_template_by_names&id=sample-agent&id2=test&other=memfree&apipass=1234&user=admin&pass=pandora

4.3.34 set stop_downtime

Para una parada planificada.

Sintaxis de llamada:

  • op=set (obligatorio)
  • op2=stop_downtime (obligatorio)
  • id=<id_downtime> (obligatorio) debe ser un id downtime.

4.3.34.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=stop_downtime&id=1&apipass=1234&user=admin&pass=pandora

4.3.35 Set new_user

Crea un nuevo usuario en Pandora FMS.

Sintaxis de llamada:

  • op=set (obligatorio)
  • op2=new_user (obligatorio)
  • id=<user_name> (obligatorio) será el nombre de usuario.
  • other=<parametros serializados> (obligatorio) son los datos del usuario, serializados en el siguiente orden:
  • <fullname>
  • <firstname>
  • <lastname>
  • <middlename>
  • <password>
  • <email>
  • <phone>
  • <languages>
  • <comments>
  • <time_autorefresh>
  • <default_event_filter>
  • <section>
  • <session_time> (-1 para establecer la sesión como permanente)


4.3.35.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_user&id=md&other=fullname|lastname|middlename|password|[email protected]|111|es|descripcion|30|event_filter|section|-1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.36 Set update_user

Actualiza un usuario seleccionado por el id en parámetro id.

Sintaxis de llamada:

  • op=set (obligatorio)
  • op2=update_user (obligatorio)
  • id=<user_name> (oligatorio) debe ser un nombre de usuario.
  • other=<parametros serializados> (obligatorio) son los datos de configuración del usuario, serializados en este orden:
  • <fullname>
  • <firstname>
  • <lastname>
  • <middlename>
  • <password>
  • <email>
  • <phone>
  • <languages>
  • <comments>
  • <is_admin>
  • <block_size>
  • <flash_chart>

4.3.36.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_user&id=example_user_name&other=example_fullname||example_lastname||example_new_passwd|example_email||example_language|example%20comment|1|30|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.37 set delete_user

Borra un usuario seleccionado.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=delete_user (obligatorio)
  • id=<nombre_usuario> (obligatorio) debe ser un nombre usuario.

4.3.37.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_user&id=md&apipass=1234&user=admin&pass=pandora

4.3.38 Set delete_user_permissions


Esta característica está en Metaconsola.


Borra premisos de usuario.

Call syntax:

  • Op = set(obligatorio)
  • Op2 =delete_user_permission(obligatorio)
  • Return_type = csv|json(obligatorio)
  • Other = id profile(obligatorio)

4.3.38.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=delete_user_permission&return_type=json&other=2&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora


Borra los permisos de un usuario Puede retornar Json o CSV, este retorno se indica mediante la URL.

4.3.39 Set add_permission_user_group


Esta característica está en Metaconsola.


Añadir permisos a un grupo de usuario.

Call syntax:

  • Op = set(obligatorio)
  • Op2 =add_permission_user_to_group(obligatorio)
  • Return_type = csv|json(obligatorio)
  • Other = user id(obligatorio)|group_id(obligatorio)|profile id(obligatorio)|No hierarchy(opcional)| permissions id(opcional)

4.3.39.1 Ejemplo

Puede retornar Json o CSV, este retorno se indica mediante la URL.

Template warning.png

no_hierarchy puede estar vacío, si es así toma el valor 0.

 


Template warning.png

id de permissions (id_up) en la tabla, se puede usar si va a modificarse un permiso existente.

 


http://localhost/pandora_console/include/api.php?op=set&op2=add_permission_user_to_group&return_type=json&other=admin|0|1|1||&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.40 set enable_disable_user

Activa un usuario desactivado.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=enable_disable_user (obligatorio)
  • id=<nombre_usuario> (obligatorio) debe ser un nombre usuario.

4.3.40.1 Ejemplos

Ejemplo 1 (Disable user 'example_name')

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_user&id=example_name&other=0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Ejemplo 2 (Enable user 'example_name')

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_user&id=example_name&other=1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.41 set meta_synch_user

Esta característica está en Metaconsola.


Sincroniza usuarios de la metaconsola con el nodo


Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=meta_synch_user (obligatorio)
  • other=<parámetros serializados> (opcional):
  • <user_name_1,user_name_2,user_name_3..> (Nombres de los usuarios separados por comas y sin espacios al inicio o al final, obligatorio)
  • <server_name> (obligatorio)
  • <profile_mode(1-0)> (opcional)
  • <group_name> (opcional)
  • <profile_1,profile_2,profile_3> (Perfiles separados por comas y sin espacios al principio y al final, opcional)
  • <create_groups(1-0)> (opcional)

4.3.41.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=meta_synch_user&apipass=1234&user=admin&pass=pandora&other=name1,name2|nodo1|0|||&other_mode=url_encode_separator_|

4.3.42 set create_group

Crea un nuevo grupo.

Call syntax:

  • op=set (obligatorio)
  • op2=create_group (obligatorio)
  • id=<group_name> (obligatorio) debe ser un nombre de grupo.
  • other=<serialized_parameters> (obligatorio), son los siguientes en este orden:
  • <icon name>
  • <parent group id> (opcional)
  • <description> (opcional)
  • <propagate acl> (opcional)
  • <desactivar las alertas> (opcional)
  • <custom id> (opcional)
  • <Informacion de contacto> (opcional)
  • <otra informacion> (opcional)

4.3.42.1 Ejemplos

Ejemplo 1 (con grupo padre: Servers)

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_group&id=example_group_name&other=applications|2&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Ejemplo 2 (sin grupo padre)

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_group&id=example_group_name2&other=computer|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.43 set update_group

Actualiza el grupo con los datos pasados como parámetros.

Call syntax:

  • op=set (obligatorio)
  • op2=update_group (obligatorio)
  • id=<group_id> (obligatorio) id_grupo.
  • other=<serialized_parameters> (obligatorio), son los siguientes en este orden:
  • <group name>
  • <icon name>
  • <parent group id>
  • <description>
  • <propagate acl>
  • <desactivar las alertas>
  • <custom id>
  • <Informacion de contacto>
  • <otra informacion>

4.3.43.1 Ejemplos

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_group&id=example_group_id&other=New%20Name|application|2|new%20description|1|0|custom%20id||&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.44 set delete_group

Eliminar un grupo

Call syntax:

  • op=set (obligatorio)
  • op2=update_group (obligatorio)
  • id=<group_id> (obligatorio) id_grupo.

4.3.44.1 Ejemplos

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_group&id=303&apipass=1234&user=admin&pass=pandora

4.3.45 set add_user_profile

Añade un perfil a un usuario.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=add_user_profile (obligatorio)
  • id=<nombre_usuario> (obligatorio) debe ser un nombre usuario.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del grupo y profile, serializados en el siguiente orden:
  • <grupo>
  • <profile>

4.3.45.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_user_profile&id=md&other=12|4&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.46 set delete_user_profile

Quita un perfil a un usuario.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=delete_user_profile (obligatorio)
  • id=<nombre_usuario> (obligatorio) debe ser un nombre usuario.
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del grupo y profile, serializados en el siguiente orden:
  • <grupo>
  • <profile>

4.3.46.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_user_profile&id=md&other=12|4&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.47 set new_incident

Crea un nuevo incidente.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=new_incident (obligatorio)
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del incidente, serializados en el siguiente orden:
  • <titulo>
  • <descripción>
  • <origen>
  • <prioridad>
  • <estado>
  • <grupo>

4.3.47.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_incident&other=titulo|descripcion%20texto|Logfiles|2|10|12&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.48 set new_note_incident

Crea una nota dentro de una incidencia.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=new_note_incident (obligatorio)
  • id=<id_incidente> (obligatorio) el id del incidente.
  • id2=<nombre_usuario> (obligatorio) el nombre del usuario.
  • other=<nota> (obligatorio) es la nota codificada en url encode.

4.3.48.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_note_incident&id=5&id2=miguel&other=una%20nota%20para%20la%20incidencia&apipass=1234&user=admin&pass=pandora

4.3.49 set validate_all_alerts

Valida todas las alertas.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=validate_all_alerts (obligatorio)

4.3.49.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_alerts&apipass=1234&user=admin&pass=pandora

4.3.50 set validate_all_policy_alerts

Valida todas las alertas que vienen de políticas.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=validate_all_policy_alerts (obligatorio)

4.3.50.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_policy_alerts&apipass=1234&user=admin&pass=pandora

4.3.51 set event_validate_filter

Valida todos los eventos que pasan el filtro pasado como parámetros.


Esta característica está en Metaconsola.


Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=event_validate_filter (obligatorio)
  • other_mode=url_encode_separator_| (opcional)
  • other=<parámetros serializados> (opcional), son los siguientes en este orden:
  • <separator>
  • <criticity> De 0 a 4
  • <nombre agente>
  • <nombre módulo>
  • <nombre plantilla de alerta>
  • <usuario>
  • <nivel mínimo intervalo numérico > en unix timestamp
  • <nivel máximo intervalo numérico > en unix timestamp

4.3.51.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=event_validate_filter&other_mode=url_encode_separator_|&other=;|2&apipass=1234&user=admin&pass=pandora

4.3.52 set event_validate_filter_pro

Es igual que la anterior.


Esta característica está en Metaconsola.


Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=event_validate_filter_pro (obligatorio)
  • other_mode=url_encode_separator_| (opcional)
  • other=<parámetros serializados> (opcional), son los siguientes en este orden:
  • <separator>
  • <criticity> De 0 a 4
  • <id agente>
  • <id modulo>
  • <id agente modulo alerta>
  • <usuario>
  • <nivel mínimo intervalo numérico > en unix timestamp
  • <nivel máximo intervalo numérico > en unix timestamp

4.3.52.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=event_validate_filter_pro&other_mode=url_encode_separator_|&other=;|2&apipass=1234&user=admin&pass=pandora

4.3.53 set new_alert_template

Aplica una alerta desde una plantilla y un módulo pasado como id de agente y nombre de módulo.


Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=new_alert_template (obligatorio)
  • id=<nombre del agente> (obligatorio)
  • id2=<nombre de la plantilla de alerta> (obligatorio)
  • other_mode=url_encode_separator_| (opcional)
  • other=<parámetros serializados> (obligatorio), son los siguientes en este orden:
  • <nombre modulo> (obligatorio)

4.3.53.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_alert_template&id=example&id2=test&other_mode=url_encode_separator_|&other=memfree&apipass=1234&user=admin&pass=pandora

4.3.54 set alert_actions

Añade acciones a una alerta.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=alert_actions (obligatorio)
  • id=<nombre del agente> (obligatorio)
  • id2=<nombre de la plantilla de alerta> (obligatorio)
  • other_mode=url_encode_separator_| (opcional)
  • other=<parámetros serializados> (obligatorio), son los siguientes en este orden:
  • <nombre modulo> (obligatorio)
  • <nombre acción> (obligatorio)
  • <fires min > (opcional)
  • <fires max > (opcional)

4.3.54.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=alert_actions&id=example&id2=test&other_mode=url_encode_separator_|&other=memfree|test&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=alert_actions&id=example&id2=test&other_mode=url_encode_separator_|&other=memfree|test|1|3&apipass=1234&user=admin&pass=pandora

4.3.55 set alert_commands

Añade comandos a una alerta.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=alert_commands (obligatorio)
  • id=<nombre del comando> (obligatorio)
  • other_mode=url_encode_separator_| (opcional)
  • other=<parámetros serializados> (obligatorio), son los siguientes en este orden:
  • <command> (obligatorio)
  • <id_group> (obligatorio)
  • <description > (opcional)
  • <internal > (opcional)
  • <field_description_1><field_value_1><field_description_2><field_value_2>...<field_description_n><field_value_n>

4.3.55.1 Ejemplos

http://localhost/pandora_console/include/api.php?op=set&op2=alert_commands&id=PRUEBA1&other=command|0|Desc|1|des1|val1|des2|val2|des3|val3||val4|des5&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.56 set new_module

Crea un nuevo módulo.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=new_module (obligatorio)
  • id=<nombre del agente> (obligatorio)
  • id2=<nombre del nuevo modulo> (obligatorio)
  • other_mode=url_encode_separator_| (opcional)
  • other=<parámetros serializados> (obligatorio), son los siguientes en este orden:
  • <tipo de modulo de red> (obligatorio)
  • <nombre acción> (obligatorio)
  • <ip o url > (obligatorio)
  • <puerto > (opcional)
  • <descripción > (opcional)
  • <min > (opcional)
  • <max > (opcional)
  • <post process > (opcional)
  • <module interval > (opcional)
  • <min warning > (opcional)
  • <max warning > (opcional)
  • <min critical > (opcional)
  • <max critical > (opcional)
  • <history data > (opcional)
  • <enable_unknown_events> (solo versión 5)

4.3.56.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_module&id=miguel-portatil&id2=juanito&other_mode=url_encode_separator_|&other=remote_tcp_string|localhost|33|descripcion%20larga&apipass=1234&user=admin&pass=pandora

4.3.57 set delete_module

Borra un módulo.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=delete_module (obligatorio)
  • id=<nombre del agente> (obligatorio)
  • id2=<nombre del modulo> (obligatorio)
  • other=simulate (opcional)

4.3.57.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module&id=example&id2=example2&other=simulate&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module&id=example&id2=example2&apipass=1234&user=admin&pass=pandora

4.3.58 set enable_alert

Activa una alerta dentro de un agente.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=enable_alert
  • id=<Nombre del agente> (obligatorio)
  • id2=<Nombre del modulo> (obligatorio)
  • other: nombre del template de la alerta (p.e: Warning event) (obligatorio)


4.3.58.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=enable_alert&id=example&id2=Status&other=Warning%20condition&apipass=1234&user=admin&pass=pandora

4.3.59 set enable_alert_alias

Activa una alerta dentro de un agente a partir del alias.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=enable_alert_alias
  • id=<Alias del agente> (obligatorio)
  • id2=<Nombre del modulo> (obligatorio)
  • other: nombre del template de la alerta (p.e: Warning event) (obligatorio)


4.3.59.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=enable_alert_alias&id=example&id2=CPU%20Load&other=critical%20condition&apipass=1234&user=admin&pass=pandora

4.3.60 set disable_alert

Desactiva una alerta dentro de un agente.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=disable_alert
  • id=<Nombre del agente> (obligatorio)
  • id2=<Nombre del modulo> (obligatorio)
  • other: nombre del template de la alerta (p.e: Warning event) (obligatorio)


4.3.60.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=disable_alert&id=example&id2=Status&other=Warning%20condition&apipass=1234&user=admin&pass=pandora

4.3.61 set disable_alert_alias

Desactiva una alerta dentro de un agente.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=disable_alert_alias
  • id=<Alias del agente> (obligatorio)
  • id2=<Nombre del modulo> (obligatorio)
  • other: nombre del template de la alerta (p.e: Warning event) (obligatorio)


4.3.61.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=disable_alert_alias&id=example&id2=CPU%20Load&other=critical%20condition&apipass=1234&user=admin&pass=pandora

4.3.62 set enable_module_alerts

Igual que la llamada enable_alert.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=enable_module_alerts
  • id=<Nombre del agente> (obligatorio)
  • id2=<Nombre del modulo> (obligatorio)


4.3.62.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=enable_module_alerts&id=example&id2=Status&apipass=1234&user=admin&pass=pandora

4.3.63 set disable_module_alerts

Igual que la llamada disable_alert.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=disable_module_alerts
  • id=<Nombre del agente> (obligatorio)
  • id2=<Nombre del modulo> (obligatorio)


4.3.63.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=disable_module_alerts&id=example&id2=Status&apipass=1234&user=admin&pass=pandora

4.3.64 set enable_module

Activa el módulo.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=enable_module
  • id=<Nombre del agente> (obligatorio)
  • id2=<Nombre del modulo> (obligatorio)


4.3.64.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=enable_module&id=example&id2=Status&apipass=1234&user=admin&pass=pandora

4.3.65 set disable_module

Desactiva el módulo.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=disable_module
  • id=<Nombre del agente> (obligatorio)
  • id2=<Nombre del modulo> (obligatorio)


4.3.65.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=disable_module&id=example&id2=Status&apipass=1234&user=admin&pass=pandora

4.3.66 set create_network_module_from_component

Crea un nuevo módulo de red desde un componente.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=create_network_module_from_component (obligatorio)
  • id=<Nombre del agente> (obligatorio)
  • id2=<Nombre del componente> (obligatorio)


4.3.66.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=create_network_module_from_component&id=example&id2=OS%20Total%20process&apipass=1234&user=admin&pass=pandora

4.3.67 set module_data

Añade un nuevo valor al módulo.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=module_data (obligatorio)
  • id=<id agente módulo> (obligatorio)
  • other: serializado el dato del módulo y el tiempo en que ocurre.
    • dato: que puede ser cualquier tipo de dato de Pandora.
    • tiempo: puede ser la cadena de texto "now" para el momento actual o el timestamp especifico.

4.3.67.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=module_data&id=14&other_mode=url_encode_separator_|&other=123|now&apipass=1234&user=admin&pass=pandora

4.3.68 set new_module_group

Crea un nuevo grupo de módulos.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=new_module_group (obligatorio)
  • id=<nombre del grupo de módulos> (obligatorio)

4.3.68.1 Ejemplos

http://localhost/pandora_console/include/api.php?op=set&op2=new_module_group&id=Module_group_name&apipass=1234&user=admin&pass=pandora

4.3.69 set module_group_synch

Esta característica está en Metaconsola.


Sincronizar grupo de módulos desde la metaconsola.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=module_group_synch (obligatorio)
  • other=<parámetros serializados> (obligatorio) en este caso el nombre del/de los servidor/es que se quiere/n sincronizar con la meta.
  • <server_name_1><server_name_2>...<server_name_n> (obligatorio)

4.3.69.1 Ejemplos

http://localhost/pandora_console/include/api.php?op=set&op2=module_group_synch&other=server_name1|server_name2|server_name3&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.70 set add_module_in_conf

>= 5.0 (Sólo Enterprise)

Añade una configuración a un módulo local.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=add_module_in_conf (obligatorio)
  • id=<id agente> (obligatorio)
  • id2=<nombre módulo> (obligatorio)
  • other: los datos del modulo que irán en el fichero de configuración codificados en base64 (obligatorio)

4.3.70.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_module_in_conf&apipass=1234&user=admin&pass=pandora&id=9043&id2=example_name&other=bW9kdWxlX2JlZ2luCm1vZHVsZV9uYW1lIGV4YW1wbGVfbmFtZQptb2R1bGVfdHlwZSBnZW5lcmljX2RhdGEKbW9kdWxlX2V4ZWMgZWNobyAxOwptb2R1bGVfZW5k

Se retornará '0' en caso de éxito,'-1' en caso de error, '-2' si ya existe

4.3.71 set delete_module_in_conf

>= 5.0 (Sólo Enterprise)

Borra la configuración de un módulo local.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=add_module_in_conf (obligatorio)
  • id=<id agente> (obligatorio)
  • id2=<nombre módulo> (obligatorio)

4.3.71.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_module_in_conf&user=admin&pass=pandora&id=9043&id2=example_name

Se retornará '0' en caso de éxito ó '-1' en caso de error

4.3.72 set update_module_in_conf

>= 5.0 (Sólo Enterprise)

Actualiza la configuración de un módulo local.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=update_module_in_conf (obligatorio)
  • id=<id agente> (obligatorio)
  • id2=<nombre módulo> (obligatorio)
  • other: los nuevos datos del módulo que irán en el fichero de configuración codificados en base64 (obligatorio)

4.3.72.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_module_in_conf&apipass=1234&user=admin&pass=pandora&id=9043&id2=example_name&other=bW9kdWxlX2JlZ2luCm1vZHVsZV9uYW1lIGV4YW1wbGVfbmFtZQptb2R1bGVfdHlwZSBnZW5lcmljX2RhdGEKbW9kdWxlX2V4ZWMgZWNobyAxOwptb2R1bGVfZW5k

Se retornará '1' si no cambia, '0' en caso de éxito, '-1' en caso de error, '-2' si no existe

4.3.73 set create_event

Crea un evento nuevo en Pandora.


Esta característica está en Metaconsola.


Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=create_event (obligatorio)
  • other=<parámetros serializados> (obligatorio) son la configuración y datos del evento, serializados en el siguiente orden:
  • <event_text> (obligatorio)(string)
  • <id_group> (obligatorio)(string)
  • <id_agent> (obligatorio)(numeric)
  • <status>(0 New, 1 Validated, 2 In process)
  • <id_user>(numeric)
  • <event_type>(unknown, alert_fired, alert_recovered, alert_ceased, alert_manual_validation, system, error, new_agent, configuration_change, going_unknown, going_down_critical, going_down_warning, going_up_normal)
  • <severity> (0 Maintenance,1 Informative,2 Normal,3 Warning,4 Crit,5 Minor, 6 Major)
  • <id_agent_module>(numeric)
  • <id_alert_am>(numeric)
  • <critical_instructions>(string)
  • <warning_instructions>(string)
  • <unknown_instructions>(string)
  • <comment>(string)
  • <owner_user>(string)
  • <source>(string)
  • <tags>(string)
  • <custom_data> Los datos personalizados se introducen como un documento JSON codificado en base 64.
  • <server_id> El nodo de la consola hija (solo para metaconsola).
  • <id_extra> (alphanumeric)

4.3.73.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_event&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora&other=Event_name|0|1|0|admin|alert_fired|4|1|||||comment|admin||tags|eyJBbnN3ZXIgdG8gdGhlIFVsdGltYXRlIFF1ZXN0aW9uIG9mIExpZmUsIHRoZSBVbml2ZXJzZSwgYW5kIEV2ZXJ5dGhpbmciOiA0Mn0=||12

4.3.74 set add_event_comment

Añade un comentario acerca del evento

Info.png

Esta característica se encuentra tanto en nodo como en Metaconsola

 


Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=add_event_comment (obligatorio)
  • other=<serialized_parameters> (obligatorio) son la configuración y datos del evento, serializados en el siguiente orden:
  • <comment> (obligatorio)

Info.png

Para poder utilizarla en Metaconsola, se debe introducir el parámetro true despues del string

 


4.3.74.1 Ejemplos

  • Nodo:
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_event_comment&id=event_id&other=string&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
  • Metaconsola:
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_event_comment&id=event_id&other=string|true&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.75 set create_netflow_filter

(>=5.0)

Crea un nuevo filtro de netflow.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=create_netflow_filter (obligatorio)
  • other=<parámetros serializados> (obligatorio) son los datos del filtro, serializados en el siguiente orden:
  • <nombre_filtro> (obligatorio)
  • <id_grupo> (obligatorio)
  • <filtro> (obligatorio)
  • <agregado_por> (Valores posibles: dstip,dstport,none,proto,srcip,srcport) (obligatorio)
  • <formato_salida> (Valores posibles: kilobytes,kilobytespersecond,megabytes,megabytespersecond) (obligatorio)

4.3.75.1 Ejemplos

http://127.0.0.1/pandora/include/api.php?op=set&op2=create_netflow_filter&apipass=1234&user=admin&pass=pandora&other=Filter%20name|9|host%20192.168.50.3%20OR%20host%20192.168.50.4%20or%20HOST%20192.168.50.6|dstport|kilobytes&other_mode=url_encode_separator_|

4.3.76 set create_custom_field

>= 5.0

Crea un nuevo campo custom.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=create_custom_field (obligatorio)
  • other=<parámetros serializados> (obligatorio) parámetros para configurar el custom field
  • <name> (obligatorio)
  • <flag_display_front> (obligatorio; 0 no se mostrará en la vista de operación, 1 si se mostrará)

4.3.76.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_custom_field&other=mycustomfield|0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.77 set create_tag

>= 5.0

Crea un nuevo tag.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=create_tag (obligatorio)
  • other=<parámetros serializados> (obligatorio) parámetros para configurar el tag
  • <name> Nombre del tag (obligatorio)
  • <description> Descripción del tag
  • <eurl> Url del tag
  • <email> Email del tag

4.3.77.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_tag&other=tag_name|tag_description|tag_url|tag_email&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.78 set enable_disable_agent

Activa un agente desactivado.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=enable_disable_agent (obligatorio)
  • id=<id_agente> (obligatorio) debe ser un id agente.

4.3.78.1 Ejemplos

Example 1 (Disable agent 'example_id')

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_agent&id=example_id&other=0&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Example 2 (Enable agent 'example_id')

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=enable_disable_agent&id=example_id&other=1&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.79 set gis_agent_only_position

>= 5.0

Añade solo la posición GIS a un agente.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=gis_agent_only_position (obligatorio)
  • id=<índice> (obligatorio) debe ser un índice de un agente.
  • other=<parámetros serializados> (obligatorio) parámetros para configurar el Gis
  • <latitude> Latitud
  • <longitude> Longitud
  • <altitude> Altitud

4.3.79.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=gis_agent_only_position&id=582&other_mode=url_encode_separator_|&other=2%7C1%7C0

4.3.80 set gis_agent

>= 5.0

Añade los datos GIS a un agente.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=gis_agent_only_position (obligatorio)
  • id=<índice> (obligatorio) debe ser un índice de un agente.
  • other=<parámetros serializados> (obligatorio) parámetros para configurar el gis
  • <latitude> Latitud
  • <longitude> Longitud
  • <altitude> Altitud
  • <ignore_new_gis_data> ignorar nuevos datos gis
  • <manual_placement> posicionamiento manual
  • <start_timestamp> tiempo de comienzo en esta posicion
  • <end_timestamp> tiempo de finalización de la anterior
  • <number_of_packages> numero de paquetes en esta posición
  • <description_save_history> descripción
  • <description_update_gis> descripción
  • <description_first_insert> descripción



4.3.80.1 Ejemplo

http://127.0.0.1/pandora5/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=gis_agent&id=582&other_mode=url_encode_separator_|&other=2%7C2%7C0%7C0%7C0%7C2000-01-01+01%3A01%3A01%7C0%7C666%7Caaa%7Cbbb%7Cccc

4.3.81 set reset_agent_counts

Actualiza el conteo de módulos y alertas de un agente.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=reset_agent_counts (obligatorio)
  • id=<id_agent> (obligatorio) debe ser un id de agente o "All".

4.3.81.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=reset_agent_counts&apipass=1234&user=admin&pass=pandora&id=All

4.3.82 set create_special_day

>= 5.1

Permite añadir un día especial.

Sintaxis:

  • op=set (obligatorio)
  • op2=create_special_day (obligatorio)
  • other=<parámetros serializados> (obligatorio)
  • <special day> Día especial
  • <same day> Mismo día
  • <description> Descripción
  • <id_group> Id Grupo

4.3.82.1 Example

http://127.0.0.1/pandora_console/include/api.php?apipass=1111&user=admin&pass=pandora&op=set&op2=create_special_day&other_mode=url_encode_separator_|&other=2014-05-03|Sunday|desc|0

4.3.83 set update_special_day

>= 5.1

Actualizar configuración de un día especial ya definido.

Sintaxis:

  • op=set (obligatorio)
  • op2=update_special_day (obligatorio)
  • id=<id día especial> (obligatorio)
  • other=<parámetros serializados> (obligatorio)
  • <special day> Día especial
  • <same day> Mismo día
  • <description> Descripción
  • <id_group> Id grupo

4.3.83.1 Example

http://127.0.0.1/pandora_console/include/api.php?apipass=1111&user=admin&pass=pandora&op=set&op2=update_special_day&id=1&other_mode=url_encode_separator_|&other=2014-05-03|Sunday|desc|0

4.3.84 set delete_special_day

>= 5.1

Permite borrar un día especial.

Sintaxis:

  • op=set (obligatorio)
  • op2=delete_special_day (obligatorio)
  • id=<id día especial> (obligatorio)

4.3.84.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?apipass=1111&user=admin&pass=pandora&op=set&op2=delete_special_day&id=1

4.3.85 set pagerduty_webhook

>= 5.1

Conecta notificaciones de PagerDuty con alertas de Pandora FMS. Esta llamada se configurará en la opción Webhook del servicio de PagerDuty para validar las alertas de Pandora FMS previamente enlazadas a PagerDuty cuando estas sean validadas desde PagerDuty.

Sintaxis:

  • op=set (obligatorio)
  • op2=pagerduty_webhook (obligatorio)
  • id=alert (obligatorio)

4.3.85.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=pagerduty_webhook&apipass=1234&user=admin&pass=pandora&id=alert

4.3.86 set tag_user_profile

>= 6

Añade un tag a un perfil de un usuario.

Sintaxis:

  • op = set (obligatorio)
  • op2 = tag_user_profile (obligatorio)
  • id = id_usuario (obligatorio)
  • id2 = id_etiqueta (obligatorio)
  • other_mode = url_encode_separator_| (obligatorio)
  • other = <id_grupo>|<id_perfil> (obligatorio)


4.3.86.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=tag_user_profile&apipass=1234&user=admin&pass=pandora&id=1&id2=2&other_mode=url_encode_separator_|&other=122|3

4.3.87 set tag

>= 6

Añade un tag a tu Pandora FMS.

Sintaxis:

  • op = set (obligatorio)
  • op2 = tag (obligatorio)
  • id = nombre (obligatorio)
  • other_mode = url_encode_separator_| (obligatorio)
  • other = <descripción>|<url>|<email>|<teléfono>


4.3.87.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=tag&apipass=1234&user=admin&pass=pandora&id=test&other_mode=url_encode_separator_|&other="un test"|http://www.artica.es|[email protected]|01189998819991197253

4.3.88 set add_tag_module

>= 6

Añade un tag a un módulo.

Sintaxis:

  • op = set (obligatorio)
  • op2 = add_tag_module (obligatorio)
  • id = id_modulo (obligatorio)
  • id2 = id_tag (obligatorio)


4.3.88.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_tag_module&apipass=1234&user=admin&pass=pandora&id=1&id2=2

4.3.89 set remove_tag_module

>= 6

Quita un tag a un módulo.

Sintaxis:

  • op = set (obligatorio)
  • op2 = add_tag_module (obligatorio)
  • id = id_modulo (obligatorio)
  • id2 = id_tag (obligatorio)


4.3.89.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=remove_tag_module&apipass=1234&user=admin&pass=pandora&id=1&id2=2

4.3.90 set planned_downtimes_created

>= 5.1

Crea una parada planificada.

  • op=set
  • op2=planned_downtimes_created
  • other=<description>;<date_from>;<date_to>;<id_group>;<monday>;
  • <tuesday>;<wednesday>;<thursday>;<friday>;<saturday>;<sunday>;<periodically_time_from>;<periodically_time_to>;
  • <periodically_day_from>;<periodically_day_to>;<type_downtime>;<type_execution>;<type_periodicity>;<id_user>;

4.3.90.1 Ejemplos

Once:

http://localhost/pandora_console/include/api.php?op=set&op2=planned_downtimes_created&apipass=1234&user=admin&pass=pandora&id=testing&other=testing|11/05/2018|11/16/2018|0|1|1|1|1|1|1|1|12:06:00|19:06:00|1|31|quiet|once|weekly|admin&other_mode=url_encode_separator_|

Periodically:

http://localhost/pandora_console/include/api.php?op=set&op2=planned_downtimes_created&apipass=1234&user=admin&pass=pandora&id=testing&other=testing|11/05/2018|11/16/2018|0|1|1|1|1|1|1|1|12:06:00|19:06:00|1|31|quiet|periodically|weekly|admin&other_mode=url_encode_separator_|

4.3.91 set planned_downtimes_additem

>= 5.1

Crea registros para una parada planificada.

  • op=set
  • op2=planned_downtimes_additem
  • id=planned_downtime_id
  • other= <id_agent1;id_agent2;id_agent3;....id_agentn;>;<name_module1;name_module2;name_module3;......name_modulen;>

4.3.91.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_additem&apipass=1234&user=admin&pass=pandora&id=123&other=1;2;3;4%7CStatus;Unkown_modules%20&other_mode=url_encode_separator_|

4.3.92 set planned_downtimes_deleted

>=5.1

Elimina una parada planificada.

  • op=set
  • op2=planned_downtimes_deleted
  • id=planned_downtime_id

4.3.92.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_deleted&apipass=1234&user=admin&pass=pandora&id=10

4.3.93 set create_synthetic_module

>=5.1SP4

Crea un módulo sintético:

  • op=set
  • op2=create_synthetic_module
  • id=Nombre del agente a añadir el módulo
  • other= <name_module><synthetic_type><AgentName;Operation;NameModule> OR <AgentName;NameModule> OR <Operation;Value>
    • Datos del módulo:
 En las creación de tipo arithmetic el primer dato si es Agente y módulo sin operador : AgentName;NameModule. Si es un valor: <Operation;Value>. El resto de valores irían ya de la forma siguiente: <AgentName;Operation;NameModule> or <Operation;Value>
 average: <AgentName;Operation;NameModule> or <Operation;Value>
    • Operaciones:
 arithmetic: ADD, SUB, MUL, DIV
 average: Only AVG

4.3.93.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_synthetic_module&apipass=1234&user=admin&pass=pandora&id=test&other=Test|arithmetic|Agent%20Name;Module%20Name|Agent%20Name2;ADD;Module%20Name2&other_mode=url_encode_separator_|
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_synthetic_module&apipass=1234&user=admin&pass=pandora&id=example&other=prueba|average|Agent%20Name;AVG;Name%20Module|Agent%20Name2;AVG;Name%20Module2&other_mode=url_encode_separator_|

4.3.94 set create_service

>= 7

Crea un servicio.

  • op=set
  • op2=create_service
  • other=<name>;<description>;<id_group>;<critical>;<warning>;<id_agent>;<sla_interval>;<sla_limit>;

<id_warning_module_template_alert>;<id_critical_module_template_alert>;<id_critical_module_sla_template_alert>;

4.3.94.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_service&return_type=json&other=test1%7CDescripcion%7C12%7C1%7C0.5%7C1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.95 set update_service

>= 7

Modifica un servicio.

  • op=set
  • op2=update_service
  • id=id del servicio
  • other=<name>;<description>;<id_group>;<critical>;<warning>;<id_agent>;<sla_interval>;<sla_limit>;

<id_warning_module_template_alert>;<id_critical_module_template_alert>;<id_critical_module_sla_template_alert>;

4.3.95.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_service&return_type=json&id=1&other=test2%7CDescripcion2%7C%7C%7C0.6%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.96 set add_element_service

>= 7

Añade uno o varios elementos al servicio.

  • op=set
  • op2=add_element_service
  • id=id del servicio
  • other=json con los elementos en base64

La estructura del json debe ser la siguiente:

[{"type":"agent","id":2,"description":"Test1","weight_critical":0,"weight_warning":0,"weight_unknown":0,"weight_ok":0},{"type":"module","id":1,"description":"Test2","weight_critical":0,"weight_warning":0,"weight_unknown":0,"weight_ok":0},{"type":"service","id":3,"description":"Test3","weight_critical":0,"weight_warning":0,"weight_unknown":0,"weight_ok":0}]

En cada tipo, el campo id hace referencia a cosas diferentes:

- Si es de tipo agent, es el id del agente.

- Si es de tipo module, es el id agente modulo

- Si es tipo service, es el id del servicio que queremos añadir.


4.3.96.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_element_service&return_type=json&id=6&other=W3sidHlwZSI6ImFnZW50IiwiaWQiOjIsImRlc2NyaXB0aW9uIjoiamlqaWppIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH0seyJ0eXBlIjoibW9kdWxlIiwiaWQiOjEsImRlc2NyaXB0aW9uIjoiSG9sYSBxdWUgdGFsIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH0seyJ0eXBlIjoic2VydmljZSIsImlkIjozLCJkZXNjcmlwdGlvbiI6ImplamVqZWplIiwid2VpZ2h0X2NyaXRpY2FsIjowLCJ3ZWlnaHRfd2FybmluZyI6MCwid2VpZ2h0X3Vua25vd24iOjAsIndlaWdodF9vayI6MH1d&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.97 set metaconsole_synch

>= 7

Añade licencia a metaconsole y sincroniza con los nodos

  • op=set
  • op2=metaconsole_synch
  • id=Código de licencia

4.3.97.1 Ejemplo

http://127.0.0.1/pandora_console/enterprise/meta/include/api.php?op=set&op2=metaconsole_synch&id=CODIGODELICENCIA&apipass=1234&user=admin&pass=pandora

4.3.98 set migrate_agent

>= 7.21 ONLY METACONSOLE

Añade a la cola de migración de agentes un agente seleccionado

  • op=set
  • op2=migrate_agent
  • id=id_agente a migrar
  • other=nombre nodo origen| nombre nodo destino | (true|false) para no migrar base de datos de histórico
  • other_mode=url_encode_separator_|
  • return_type = string, json, etc

4.3.98.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=migrate_agent&apipass=1234&user=admin&pass=pandora&id=2&other=example|example2|0&other_mode=url_encode_separator_|&return_type=string

4.3.99 set new_cluster

>= 7.0

Crea un cluster de agentes

Crea un cluster de monitorización con agentes e items para monitorizar distintos nodos.

  • op=set
  • op2=new_cluster
  • other=nombre_cluster| tipo_cluster| descripcion| id_grupo
  • other_mode=url_encode_separator_

4.3.99.1 Ejemplo

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_cluster&other=nombre_cluster%7CAA%7Cdescripcion%7C12&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.100 set add_cluster_agent

>= 7.0

Añadir agente a cluster

  • op=set
  • op2=add_cluster_agent
  • other=json con los elementos en base64
  • other_mode=url_encode_separator_

La estructura del json debe ser la siguiente:

[{"id":5,"id_agent":2}, {"id":5,"id_agent":3}]

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_agent&other=W3siaWQiOjUsImlkX2FnZW50IjoyfSwKeyJpZCI6NSwiaWRfYWdlbnQiOjN9XQ==&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.101 set add_cluster_item (activo/activo)

>= 7.0

Añadir item activo/activo a cluster

  • op=set
  • op2=add_cluster_item
  • other=json con los elementos en base64
  • other_mode=url_encode_separator_

La estructura del json debe ser la siguiente:

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

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_item&other=W3sibmFtZSI6IlN3YXBfVXNlZCIsImlkX2NsdXN0ZXIiOjUsInR5cGUiOiJBQSIsImNyaXRpY2FsX2xpbWl0Ijo4MCwid2FybmluZ19saW1pdCI6NjB9LAp7Im5hbWUiOiJUQ1BfQ29ubmVjdGlvbnMiLCJpZF9jbHVzdGVyIjo1LCJ0eXBlIjoiQUEiLCJjcml0aWNhbF9saW1pdCI6ODAsIndhcm5pbmdfbGltaXQiOjYwfV0=&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.102 set add_cluster_item (active/passive)

>= 7.0

Añadir item activo/pasivo a cluster

  • op=set
  • op2=add_cluster_item
  • other=json con los elementos en base64
  • other_mode=url_encode_separator_

La estructura del json debe ser la siguiente:

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

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_cluster_item&other=W3sibmFtZSI6IkRpc2tVc2VkXy9wcm9jL2tjb3JlIiwiaWRfY2x1c3RlciI6NSwidHlwZSI6IkFQIiwiaXNfY3JpdGljYWwiOjF9LAp7Im5hbWUiOiJEaXNrVXNlZF8vcHJvYy9zY2hlZF9kZWJ1ZyIsImlkX2NsdXN0ZXIiOjUsInR5cGUiOiJBUCIsImlzX2NyaXRpY2FsIjoxfV0=&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.103 set delete_cluster

>= 7.0

Eliminar cluster

  • op=set
  • op2=delete_cluster
  • id=id de cluster a eliminar
 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster&id=7&apipass=1234&user=admin&pass=pandora

4.3.104 set delete_cluster_agents

>= 7.0

Desasociar un agente de un cluster

  • op=set
  • op2=delete_cluster_agent
  • other=json con los elementos en base64
  • other_mode=url_encode_separator_

La estructura del json debe ser la siguiente:

[{"id":5,"id_agent":2}, {"id":5,"id_agent":3}]

4.3.104.1 Ejemplo

 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster_agent&other=W3siaWQiOjUsImlkX2FnZW50IjoyfSwKeyJpZCI6NSwiaWRfYWdlbnQiOjN9XQ==&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.105 set delete_cluster_item

>= 7.0

Eliminar item de un cluster

  • op=set
  • op2=delete_cluster_item
  • id=id del item a eliminar
 http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_cluster_item&id=9&apipass=1234&user=admin&pass=pandora

4.3.106 set create_policy

>= 7.0. 725

Crear una política. Son obligatorios el nombre de la política, el cual no puede estar repetido y el id_grupo el cual debe existir en la bbdd.

  • op = set
  • op2 = create_policy
  • other = nombre de la política (obligatorio) | id_del grupo (obligatorio) | descripción;
  • other_mode = url_encode_separator_|
  • return_type = (string, csv, json).

4.3.106.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=create_policy&apipass=1234&user=admin&pass=pandora&other=name%20Policy|11|this%20description&other_mode=url_encode_separator_|&return_type=json

4.3.107 set update_policy

>= 7.0. 725

Actualizar una política. El nombre de la política no puede estar repetido y el id_grupo debe existir en la bbdd. devuelve 0 (false) o id de la política actualizada (true).

  • op = set
  • op2 = update_policy
  • id = id política
  • other = nombre de la política | id_del grupo | descripción;
  • other_mode = url_encode_separator_|
  • return_type = (string, csv, json).

4.3.107.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=update_policy&apipass=1234&user=admin&pass=pandora&id=17&other=policy2|11|this%20description&other_mode=url_encode_separator_|&return_type=json

4.3.108 set delete_policy

>= 7.0. 725

Eliminar una política. es necesario introducir el id de política y que exista dicha política para poder eliminarla. devuelve 0 (false) o 1 (true).

  • op = set
  • op2 = delete_policy
  • id = id política
  • return_type = (string, csv, json).

4.3.108.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=delete_policy&apipass=1234&user=admin&pass=pandora&id=10&return_type=json

4.3.109 set add_collections_policy

>= 7.0. 725

Añadir una colección a una política. Es necesario introducir el id de política y que exista dicha política, como un id, nombre o nombre corto de la colección que se quiera añadir la cual debe existir. Ambos campos son obligatorios. devuelve 0 (false) o el id de la colección añadida a una politica (true).

  • op = set
  • op2 = add_collections_policy
  • id = id política
  • id2 = id, nombre o nombre corto
  • return_type = (string, csv, json).

4.3.109.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=add_collections_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=4&id2=apache_plugin

4.3.110 set remove_collections_policy

>= 7.0. 725

Para marcar una colección de una política que esta pendiente de ser borrada es necesario:

  • Un id de política y que exista dicha política. Obligatorio
  • Un id, nombre o nombre corto de la colección que se quiera eliminar la cual debe existir. Obligatorio
  • Y 0 ó 1: siendo 1 marcar como pendiente de ser borrada y si es 0 quita la marca de pendiente de ser borrada por defecto si no se añade este campo intentará marcar para que se pueda borrar.

devuelve 0 (false) o 1 (true).

  • op = set
  • op2 = remove_collections_policy
  • id = id política
  • id2 = id, nombre o nombre corto
  • other = (bool) 0 ó 1
  • return_type = (string, csv, json).

4.3.110.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=remove_collections_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=4&id2=2&other=1.

4.3.111 set create_plugins_policy

>= 7.0. 725

Para añadir un plugin a una política es necesario:

  • Un id de política y que exista dicha política. Obligatorio
  • La cadena del plugin a ejecutar. Obligatorio

Devuelve 0 (false) o el id del plugin que ha sido añadido a una política (true).

  • op = set
  • op2 = create_plugins_policy
  • id = id política
  • id2 = cadena de texto
  • return_type = (string, csv, json).

4.3.111.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=create_plugins_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=2&id2=echo%201

4.3.112 set delete_plugins_policy

>= 7.0. 725

Para eliminar un plugin de una política es necesario:

  • Un id de política y que exista dicha política. Obligatorio
  • Un id de plugin que se quiera eliminar. Obligatorio
  • 0 ó 1: siendo 1 marcar como pendiente de ser borrado el plugin y si es 0 quita la marca de pendiente de ser borrado por defecto si no se añade, este campo se marca como pendiente de ser borrado.

devuelve 0 (false) o 1 (true).

  • op = set
  • op2 = delete_plugins_policy
  • id = id política
  • id2 = id plugin
  • other = 0 ó 1
  • return_type = (string, csv, json).

4.3.112.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=delete_plugins_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=2&id2=1&other=1

4.3.113 set linking_policy

>= 7.0. 725

Para enlazar un módulo desenlazado de una política es necesario:

  • Un id de agente modulo que este desenlazado.

devuelve 0 (false) o 1 (true).

  • op = set
  • op2 = linking_policy
  • id = id agente modulo
  • return_type = (string, csv, json).

4.3.113.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=linking_policy&apipass=1234&user=admin&pass=pandora&return_type=json&id=28

4.3.114 set create_alerts_policy

>= 7.0. 725

Para crear alertas de una política es necesario:

  • Un id de política que debe existir (obligatorio).
  • Un id módulo de política si es de tipo normal es obligatorio
  • Una id plantilla que debe existir (obligatorio).
  • Si es o no external 0 (normal), 1 (external). Por defecto es 0 normal
  • Es obligatorio en caso de ser de tipo external (1) nombre de módulo con el que coincidir.

devuelve 0 (false) o el id de la alerta añadida en la política (true).

  • op = set
  • op2 = create_alerts_policy
  • id = id política
  • id2 = id modulo política
  • other = id modulo política|id template|0 ó 1|nombre de modulo.
  • other_mode = url_encode_separator_|
  • return_type = (string, csv, json).

4.3.114.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=create_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=2&other=0|2|1|cpu%20load&other_mode=url_encode_separator_|

4.3.115 set update_alerts_policy

>= 7.0. 725

Para actualizar alertas de una política es necesario:

  • Un id de política que debe existir (obligatorio).
  • Activo 0 | En espera 1
  • habilitar 0 | deshabilitar 1

devuelve 0 (false) o el id de la alerta actualizada en la política (true).

  • op = set
  • op2 = update_alerts_policy
  • id = id política
  • other = 0 ó 1 (activar/desactivar) | 0 ó 1 (habilitar/deshabilitar).
  • other_mode = url_encode_separator_|
  • return_type = (string, csv, json).

4.3.115.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=update_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=7&other=1|1&other_mode=url_encode_separator_|

4.3.116 set delete_alerts_policy

>= 7.0. 725

Para eliminar una alerta de una política es necesario:

  • Un id de alerta de política que debe existir (obligatorio).
  • 0 | 1 marcar pendiente de eliminación o no por defecto si no se añade este campo se queda a 1
  • Activo 0 | En espera 1

devuelve 0 (false) o 1 (true).

  • op = set
  • op2 = delete_alerts_policy
  • id = id política
  • id2 = 0 ó 1.
  • return_type = (string, csv, json).

4.3.116.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=delete_alerts_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=7&id2=1

4.3.117 set create_alerts_actions_policy

>= 7.0. 725

Para añadir una acción a una alerta de una política es necesario:

  • Un id de alerta de política que debe existir (obligatorio).
  • Un id de acción de política que debe existir (obligatorio).
  • Se le puede añadir número mínimo de disparos o número máximo de disparos por defecto: 0

devuelve 0 (false) o el id de la acción añadida a la alerta de una política (true).

  • op = set
  • op2 = create_alerts_action_policy
  • id = id política
  • id2 = id acción
  • other = min fires | max fires
  • other_mode=url_encode_separator_|
  • return_type = (string, csv, json).

4.3.117.1 Ejemplo

http://172.16.0.2/pandora_console/include/api.php?op=set&op2=create_alerts_actions_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=1&id2=4&other=5|2&other_mode=url_encode_separator_|

4.3.118 set delete_alerts_actions_policy

>= 7.0. 725

Para eliminar una acción de una alerta de una política es necesario:

  • Un id de alerta de política que debe existir (obligatorio).
  • Un id de acción de política que debe existir (obligatorio).
  • op = set
  • op2 = delete_alerts_action_policy
  • id = id política
  • id2 = id acción
  • return_type = (string, csv, json).

4.3.118.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=delete_alerts_actions_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=1&id2=4

4.3.119 set remove_agents_policy

>= 7.0. 725

Para eliminar un agente de una política es necesario:

  • Un id de política que debe existir (obligatorio).
  • Un id de agente que debe existir (obligatorio).
  • op = set
  • op2 = remove_agents_policy
  • id = id política
  • id2 = id grupo
  • return_type = (string, csv, json).

4.3.119.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=remove_agents_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=5&id2=2

4.3.120 set add_groups_policy

>= 7.0. 725

Para agregar un grupo de una política es necesario:

  • Un id de política que debe existir (obligatorio).
  • Un id de grupo que debe existir (obligatorio).
  • op = set
  • op2 = add_groups_policy
  • id = id política
  • id2 = id grupo
  • return_type = (string, csv, json).

4.3.120.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=add_groups_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=7&id2=12

4.3.121 set remove_groups_policy

>= 7.0. 725

Para eliminar un agente de una política es necesario:

  • Un id de política que debe existir (obligatorio).
  • Un id de grupo que debe existir (obligatorio).
  • op = set
  • op2 = add_groups_policy
  • id = id política
  • id2 = id grupo
  • return_type = (string, csv, json).

4.3.121.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=remove_groups_policy&apipass=1234&user=admin&pass=pandora&return_type=string&id=5&id2=2

4.3.122 set create_os

>= 7.0. 727

Crea un nuevo sistema operativo con los datos pasados como parámetros.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=create_os (obligatorio)
  • other=<parámetros serializados> (obligatorio) son los datos del sistema operativo, serializados en el siguiente orden:
  • <nombre>
  • <descripcion>
  • <icono>

4.3.122.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_os&other=os_name%7Cos_description%7Cos_icon.png&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.123 set update_os

>= 7.0. 727

Actualiza el sistema operativo con los datos pasados como parámetros.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=update_os (obligatorio)
  • id=<id de sistema operativo> (obligatorio)
  • other=<parámetros serializados> (obligatorio) son los datos del sistema operativo, serializados en el siguiente orden:
  • <nombre>
  • <descripcion>
  • <icono>

4.3.123.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?id=107&op=set&op2=update_os&other=os_name_to_update%7Cos_description_to_update%7Cos_icon_to_update.png&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.124 set disabled_and_standby

>= 7.0. 728

Deshabilita un agente y, si tiene configuración remota, lo pone en modo standby.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=disabled_and_standby (obligatorio)
  • id=<id del agente> (obligatorio). En la metaconsola es el id de tagente, es decir, el id del nodo.
  • id2=<id del nodo> (obligatorio en la metaconsola, innecesario en el nodo)
  • other=<valor> (opcional) Valor (0 para habilitar y 1 para deshabilitar) del nuevo estado. Si no se especifica ningún valor, deshabilita el agente.

4.3.124.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?id=2&op=set&op2=disabled_and_standby&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?id=2&id2=1&op=set&op2=disabled_and_standby&other=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.125 set validate_traps

>= 7.0. 728

Permite validar traps.

  • op = set
  • op2 = validate_traps
  • id = id del trap

4.3.125.1 Ejemplo

https://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_traps&id=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.126 set delete_traps

>= 7.0. 728

Permite eliminar un trap:

  • op = set
  • op2 = delete_traps
  • id = id del trap

4.3.126.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?id=2&op=set&op2=delete_traps&id=1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.127 set access_process

>= 7.0NG. 728

Esta función permite gestionar el acceso a una tercera aplicación a partir de registros en el system audit log de pandorafms. Utiliza diferentes parámetros para procesar una de estas acciones de registro en nuestra aplicación y evita el acceso concurrente de usuarios administradores. Opcionalmente puede prohibir el acceso a usuarios no administradores.

Sintaxis de la llamada:

  • op = set
  • op2 = access_process
  • other=<parámetros obligatorios>:
  • <id_usuario>

El id del usuario que intenta acceder a la aplicación, este dato queda registrado y se comprueba en la auditoría para filtrar el acceso, salida, explusión o navegación del usuario a través de la aplicación.

  • <acción> - (login,logout,exclude,browse)

login: Se usa para solicitar el acceso a la aplicación. Delvuelve la cadena de texto "free" y registra nuestro acceso en la auditoría de pandorafms o devuelve la cadena de texto "denied" si en los registros de la auditoría hay otro usuario que haya accedido anteriormente al sistema y no haya salido aún. También devolverá "denied" si el parámetro de acceso solo para administradores está activado y el usuario no lo es.

logout: Registra la salida de un usuario de la aplicación para que vuelva a estar permitido el acceso a otros usuarios.

browse: Se debe de utilizar en todas las páginas de la aplicación externa, ya que comprueba si éste usuario sigue siendo el último que ha accedido o ha sido expulsado de la aplicación.

exclude: Expulsa al usuario registrado actualmente y registra el acceso de otro que hayamos enviado en el parámetro de id_usuario.

  • <dirección_ip_aplicación>

IP de la aplicación desde la que se está accediendo. Se registro y se comprueba en la auditoría de pandorafms para comprobar el estado de acceso de los usuarios en la aplicación.

  • <nombre_aplicación>

Nombre de la aplicación desde la que se está accediendo. Se registro y se comprueba en la auditoría de Pandora FMS para comprobar el estado de acceso de los usuarios en la aplicación.

  • <acceso_solo_administradores>

Prohibe el acceso de usuarios no administradores.

4.3.127.1 Ejemplo (requiere entorno adaptado)

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=access_process&other=1%7Clogin%7C192.168.50.25%7Cexternal_app%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.128 set create_event_response

Crea una nueva respuesta de evento.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=create_event_response (obligatorio)
  • return_type=csv|json (obligatorio)
  • other=<parámetros serializados> (todos obligatorios). Por este orden
  • <nombre>
  • <descripción>
  • <target> Si el cuarto parámetro (<tipo>) es command, aquí hay que indicar el comando que se quiere que ejecute la respuesta al evento. En cambio, si es url, se debe indicar la URL a la que se desea acceder como respuesta al evento.
  • <tipo> command o url.
  • <id del grupo> El usuario deberá tener permisos sobre el grupo indicado.
  • <ancho de la ventana modal> En píxeles.
  • <alto de la ventana modal> En píxeles.
  • <nueva ventana> 1 o 0. Indica si la URL se muestra en una ventana nueva (1) o sobre una ventana modal (0).
  • <parámetros> Parámetros que complementan la ejecución del comando.
  • <servidor> Id del servidor donde se desea que se ejecute el comando. Para la consola local el valor es 0.

4.3.128.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=create_event_response&other=response%7Cdescription%20response%7Ctouch%7Ccommand%7C0%7C650%7C400%7C0%7Cresponse%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.129 set update_event_response

Edita una respuesta de evento existente. El usuario debe de tener permisos sobre el grupo al que pertenece la respuesta para poder editarla.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=update_event_response (obligatorio)
  • return_type=csv|json (obligatorio)
  • id=<id de la respuesta de eventos> (obligatorio)
  • other=<parámetros serializados> (opcionales). Por este orden
  • <nombre>
  • <descripción>
  • <target> Si el cuarto parámetro (<tipo>) es command, aquí hay que indicar el comando que se quiere que ejecute la respuesta al evento. En cambio, si es url, se debe indicar la URL a la que se desea acceder como respuesta al evento.
  • <tipo> command o url.
  • <id del grupo> El usuario deberá tener permisos sobre el grupo indicado.
  • <ancho de la ventana modal> En píxeles.
  • <alto de la ventana modal> En píxeles.
  • <nueva ventana> 1 o 0. Indica si la URL se muestra en una ventana nueva (1) o sobre una ventana modal (0).
  • <parámetros> Parámetros que complementan la ejecución del comando.
  • <servidor> Id del servidor donde se desea que se ejecute el comando. Para la consola local el valor es 0.

4.3.129.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=update_event_response&id=7&other=response%7Cdescription%20response%7Ctouch%7Ccommand%7C0%7C650%7C400%7C0%7Cresponse%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.130 set delete_event_response

Borra una respuesta de evento. El usuario debe de tener permisos sobre el grupo al que pertenece la respuesta para poder borrarla.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=delete_event_reponse (obligatorio)
  • return_type=csv|json
  • id=<id de la respuesta de eventos> (obligatorio)

4.3.130.1 Ejemplo

http://localhost/pandora_console/include/api.php?op=set&op2=delete_event_response&id=7&apipass=1234&user=admin&pass=pandora

4.3.131 set create_user_profile_info

Crea un nuevo perfil de usuario.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=create_user_profile_info (obligatorio)
  • return_type=csv|json (obligatorio)
  • other=<parámetros serializados> Por este orden
  • <nombre> (obligatorio)
  • <bits de acceso>: 1 si se quiere activar el bit y 0 en caso contrario. No son obligatorios pero si no se especifica ningún valor se marcará el bit como no activo. Por este orden: IR|IW|IM|AR|AW|AD|LW|LM|UM|DM|ER|EW|EM|RR|RW|RM|MR|MW|MM|VR|VW|VM|PM.

Info.png

Para saber que permisos debemos activar, visite el siguiente enlace.

 


4.3.131.1 Ejemplos

Este ejemplo crea un perfil que da un acceso de solo lectura a Pandora FMS, es decir, es igual que el perfil predefinido Operator (read).

http://localhost/pandora_console/include/api.php?op=set&op2=create_user_profile_info&return_type=json&other=API_profile%7C1%7C0%7C0%7C1%7C0%7C0%7C0%7C0%7C0%7C0%7C1%7C0%7C0%7C1%7C0%7C0%7C1%7C0%7C0%7C1%7C0%7C0%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.132 set update_user_profile_info

Actualiza nuevo perfil de usuario existente.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=update_user_profile_info (obligatorio)
  • other=<parámetros serializados> (todos opcionales) Por este orden
  • <nombre>
  • <bits de acceso>: 1 si se quiere activar el bit y 0 si se quiere deshabilitar. Si no se especifica ningún valor, no cambiará. Por este orden: IR|IW|IM|AR|AW|AD|LW|LM|UM|DM|ER|EW|EM|RR|RW|RM|MR|MW|MM|VR|VW|VM|PM.


Info.png

Para saber que permisos debemos activar, visite el siguiente enlace.

 


4.3.132.1 Ejemplos

En este ejemplo se cambia el nombre del perfil con ID 6 a API_profile_updated y se le dan todos los permisos (lectura, escritura y gestión) en lo relacionado a agentes y se elimina el permiso de lectura de eventos.

http://localhost/pandora_console/include/api.php?op=set&op2=update_user_profile_info&return_type=json&id=6&other=API_profile_updated%7C%7C%7C%7C1%7C1%7C1%7C%7C%7C%7C%7C0%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.133 set delete_user_profile_info

Borra un perfil de usuario. También elimina todas las asignaciones de ese perfil a cualquier usuario.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=delete_user_profile_info (obligatorio)
  • return_type=csv|json
  • id=<id del perfil> (obligatorio)

4.3.133.1 Ejemplos

http://localhost/pandora_console/include/api.php?op=set&op2=delete_user_profile_info&return_type=json&id=8&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.134 set create_event_filter

Crea un filtro de evento.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=create_event_filter (obligatorio)
  • other=<parámetros serializados>. Por este orden:
  • <id_group_filter>
  • <id_group>
  • <event_type [new_agent|alert_recovered|alert_ceased|alert_fired|configuration_change|error|alert_manual_valdation|critical|normal|warning|not_normal|recon_host_detected|system|unknown|going_unknown]>
  • <severity [0|1|2|3|4|5|6|20|21|34]> (0: Mantenimiento, 1: Informativo, 2: Normal, 3: Advertencia, 4: Crítico, 5: Menor, 6: Principal, 20: No normal, 21: Crítico/Normal, 34: Advertencia/Crítico)
  • <event_status [2|3|0|1]> (0: Solo nuevos, 1: Solo validados, 2: Solo en proceso, 3: Solo no validados)
  • <free_search>
  • <agent_id>
  • <pagination_size [25|50|100|200|500]>
  • <max_hours_old>
  • <id_user_ack>
  • <duplicate [0|1]> (0: Todos los eventos, 1: Eventos agrupados)
  • <date_from> (formato: AAAA/MM/DD)
  • <date_to> (formato: AAAA/MM/DD)
  • <events_with_tags> (formato: ["id_etiqueta_1", "id_etiqueta_2", id_etiqueta3", "..."])
  • <events_without_tags> (formato: ["id_etiqueta_1", "id_etiqueta_2", "id_etiqueta3", "..."])
  • <alert_events [0|1]> (0: filtrar por eventos de alertas, 1: Solo eventos de alertas)
  • <module_id>
  • <source>
  • <id_extra>
  • <user_comment>

4.3.134.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_event_filter&id=test&other=%7C%7Cerror%7C4%7C%7C%7C1%7C%7C12%7C%7C%7C2018-12-09%7C2018-12-13%7C[%226%22]%7C[%2210%22,%226%22,%223%22]%7C1%7C10%7C%7C%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.135 set update_event_filter

Actualiza un filtro de evento.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=update_event_filter (obligatorio)
  • id=<event_filter_id> (obligatorio) debe ser un id de filtro de evento existente.
  • other=<parámetros serializados> (opcionales). Por este orden
  • <id_group_filter>
  • <id_group>
  • <event_type [new_agent|alert_recovered|alert_ceased|alert_fired|configuration_change|error|alert_manual_valdation|critical|normal|warning|not_normal|recon_host_detected|system|unknown|going_unknown]>
  • <severity [0|1|2|3|4|5|6|20|21|34]> (0: Mantenimiento, 1: Informativo, 2: Normal, 3: Advertencia, 4: Crítico, 5: Menor, 6: Principal, 20: No normal, 21: Crítico/Normal, 34: Advertencia/Crítico)
  • <event_status [2|3|0|1]> (0: Solo nuevos, 1: Solo validados, 2: Solo en proceso, 3: Solo no validados)
  • <free_search>
  • <agent_id>
  • <pagination_size [25|50|100|200|500]>
  • <max_hours_old>
  • <id_user_ack>
  • <duplicate [0|1]> (0: Todos los eventos, 1: Eventos agrupados)
  • <date_from> (formato: AAAA/MM/DD)
  • <date_to> (formato: AAAA/MM/DD)
  • <events_with_tags> (formato: ["id_etiqueta_1", "id_etiqueta_2", "id_etiqueta3", "..."])
  • <events_without_tags> (formato: ["id_etiqueta_1", "id_etiqueta_2", "id_etiqueta3", "..."])
  • <alert_events [0|1]> (0: filtrar por eventos de alertas, 1: Solo eventos de alertas)
  • <module_id>
  • <source>
  • <id_extra>
  • <user_comment>

4.3.135.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_event_filter&id=195&other=new_name%7C%7C%7Calert_recovered%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C%7C&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.136 set delete_event_filter

Borra un filtro de evento.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=delete_event_filter (obligatorio)
  • id=<event_filter_id> (obligatorio) debe ser un id de filtro de evento existente.

4.3.136.1 Ejemplo

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_event_filter&id=38&apipass=1234&user=admin&pass=pandora

4.3.137 get all_event_filters

Devuelve la lista de filtros de eventos existentes.

Sintaxis de la llamada:

  • op=get (obligatorio)
  • op2=all_event_filters (obligatorio)
  • other=cvs_separator (opcional)

4.3.137.1 Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_event_filters&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

4.3.138 set create_inventory_module

Crea un nuevo módulo de inventario.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=create_inventory_module (obligatorio)
  • return_type=csv|json
  • other=<parámetros serializados> Por este orden
  • <nombre> (obligatorio)
  • <descripcción>: (obligatorio pero puede ser vacío)
  • <id sistema operation>: (obligatorio). Id numérico de la tabla tconfig_os
  • <intérprete>: (obligatorio aunque puede ser vacío). Si el intérprete es vacío se interpreta que solo es un módulo de inventario local.
  • <código>: (obligatorio pero puede ser vacío) Script que tiene que ejecutarse para obtener los datos de inventario. Debe pasarse en base64.
  • <formato de los datos>: (obligatorio) Cabecera de los datos extraídos (separados por ;).
  • <modo block>: (obligatorio) 1 o 0.

4.3.138.1 Ejemplo

Este ejemplo crea módulo llamado OS de inventario que recoge los datos kernel-name y nodename de un sistema Linux.

http://localhost/pandora_console/include/api.php?op=set&op2=create_inventory_module&return_type=json&other=OS%7COS_name_description%7C1%7C/bin/bash%7CIyEvYmluL2Jhc2gKZWNobyB1bmFtZSAtbiAtcw==%7Ckernelname;nodename%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.139 set update_inventory_module

Actualiza un módulo de inventario.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=update_inventory_module (obligatorio)
  • id= ID del módulo de inventario (obligatorio)
  • return_type=csv|json
  • other=<parámetros serializados> Por este orden
  • <nombre> (obligatorio)
  • <descripcción>: (obligatorio pero puede ser vacío)
  • <id sistema operation>: (obligatorio). Id numérico de la tabla tconfig_os
  • <intérprete>: (obligatorio aunque puede ser vacío). Si el intérprete es vacío se interpreta que solo es un módulo de inventario local.
  • <código>: (obligatorio pero puede ser vacío) Script que tiene que ejecutarse para obtener los datos de inventario. Debe pasarse en base64.
  • <formato de los datos>: (obligatorio) Cabecera de los datos extraídos (separados por ;).
  • <modo block>: (obligatorio) 1 o 0.

4.3.139.1 Ejemplos

http://localhost/pandora_console/include/api.php?op=set&op2=update_inventory_module&return_type=json&id=42&other=OS_easy%7COS_name_description%7C1%7C/bin/bash%7CIyEvYmluL2Jhc2gKZWNobyB1bmFtZSAtbiAtcw==%7Ckernelname;nodename%7C0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.140 set delete_inventory_module

Borra un perfil de usuario. También elimina todas las asignaciones de ese perfil a cualquier usuario.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=delete_inventory_module (obligatorio)
  • return_type=csv|json
  • id=<id del módulo de inventario> (obligatorio)

4.3.140.1 Ejemplos

http://localhost/pandora_console/include/api.php?op=set&op2=delete_inventory_module&return_type=json&id=42&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

4.3.141 set create_collection

Crea una colección.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=create_collection (obligatorio)
  • other=<valores serializados> (obligatorio) Valores serializados para crear la colección:
  • <name>
  • <short_name>
  • <id_group>
  • <description>

Es necesario acompañarlo con 'other_mode' de la siguiente manera: other_mode=url_encode_separator_<separador> para pasar el separador de los valores serializados de other.

4.3.141.1 Ejemplos

http://localhost/pandora_console/include/api.php?op=set&op2=create_collection&other=test_plugin|test_p|0|test&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

4.3.142 set delete_collection

Elimina una colección.

Sintaxis de la llamada:

  • op=set (obligatorio)
  • op2=delete_collection (obligatorio)
  • id= id_collection (obligatorio)

4.3.142.1 Ejemplos

http://localhost/pandora_console/include/api.php?op=set&op2=delete_collection&id=15&apipass=1234&user=admin&pass=pandora

5 Ejemplos

Distintos ejemplos simples de llamada al API en distintos lenguajes.

5.1 Ejemplo

http://127.0.0.1/pandora5/include/api.php?apipass=1234&user=admin&pass=pandora&op=set&op2=gis_agent&id=582&other_mode=url_encode_separator_|&other=2%7C2%7C0%7C0%7C0%7C2000-01-01+01%3A01%3A01%7C0%7C666%7Caaa%7Cbbb%7Cccc

5.2 PHP

<?php
$ip = '192.168.70.110';
$pandora_url = '/pandora5';
$apipass = '1234';
$user = 'admin';
$password = 'pandora';
$op = 'get';
$op2 = 'all_agents';
$return_type = 'csv';
$other = '';
$other_mode = '';

$url = "http://" . $ip . $pandora_url . "/include/api.php";

$url .= "?";
$url .= "apipass=" . $apipass;
$url .= "&user=" . $user;
$url .= "&pass=" . $password;
$url .= "&op=" . $op;
$url .= "&op2=" . $op2;
if ($id !== '') {
	$url .= "&id=" . $id;
}
if ($id2 !== '') {
	$url .= "&id2=" . $id2;
}
if ($return_type !== '') {
	$url .= "&return_type=" . $return_type;
}
if ($other !== '') {
	$url .= "&other_mode=" . $other_mode;
	$url .= "&other=" . $other;
}

$curlObj = curl_init();
curl_setopt($curlObj, CURLOPT_URL, $url);
curl_setopt($curlObj, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($curlObj);
curl_close($curlObj);

$agents = array();
if (!empty($result)) {
	$lines = explode("\n", $result);
	foreach ($lines as $line) {
		$fields = explode(";", $line);
		
		$agent = array();
		$agent['id_agent'] = $fields[0];
		$agent['name'] = $fields[1];
		$agent['ip'] = $fields[2];
		$agent['description'] = $fields[3];
		$agent['os_name'] = $fields[4];
		$agent['url_address'] = $fields[5];
		
		$agents[] = $agent;
	}
}

print_list_agents($agents);

function print_list_agents($agents) {
	echo "<table border='1' style='empty-cells: show;'>";
	
	echo "<thead>";
	echo "<tr>";
	echo "<th>" . "ID" . "</th>";
	echo "<th>" . "Name" . "</th>";
	echo "<th>" . "IP" . "</th>";
	echo "<th>" . "Description" . "</th>";
	echo "<th>" . "OS" . "</th>";
	echo "<th>" . "URL" . "</th>";
	echo "</tr>";
	echo "</thead>";
	
	foreach ($agents as $agent) {
		echo "<tr>";
		echo "<td>" . $agent['id_agent'] . "</td>";
		echo "<td>" . $agent['name'] . "</td>";
		echo "<td>" . $agent['ip'] . "</td>";
		echo "<td>" . $agent['description'] . "</td>";
		echo "<td>" . $agent['os_name'] . "</td>";
		echo "<td>" . $agent['url_address'] . "</td>";
		echo "</tr>";
	}
	echo "</table>";
}
?>

5.3 Python

import pycurl
import cStringIO
import pprint

def main():
	ip = '192.168.70.110'
	pandora_url = '/pandora5'
	apipass = '1234'
	user = 'admin'
	password = 'pandora'
	op = 'get'
	op2 = 'all_agents'
	return_type = 'csv'
	other = ''
	other_mode = ''
	
	url = "http://" + ip  + pandora_url + "/include/api.php"
	
	url += "?"
	url += "apipass=" + apipass
	url += "&user="  + user
	url += "&pass=" + password
	url += "&op=" + op
	url += "&op2=" + op2
	
	buf = cStringIO.StringIO()
	
	c = pycurl.Curl()
	c.setopt(c.URL, url)
	c.setopt(c.WRITEFUNCTION, buf.write)
	c.perform()
	
	output = buf.getvalue()
	buf.close()
	
	lines = output.split("\n")
	agents = []
	for line in lines:
		if not line:
			continue
		
		fields = line.split(";")
		agent = {}
		agent['id_agent'] = fields[0]
		agent['name'] = fields[1]
		agent['ip'] = fields[2]
		agent['description'] = fields[3]
		agent['os_name'] = fields[4]
		agent['url_address'] = fields[5]
		
		agents.append(agent)
	
	for agent in agents:
		print("---- Agent #" + agent['id_agent'] + " ----")
		print("Name: " + agent['name'])
		print("IP: " + agent['ip'])
		print("Description: " + agent['description'])
		print("OS: " + agent['os_name'])
		print("URL: " + agent['url_address'])
		print("")

if __name__ == "__main__":
    main()


5.4 Perl

use strict;
use warnings;
use WWW::Curl::Easy;

sub write_callback { 
	my ($chunk,$variable) = @_; 
	
	push @{$variable}, $chunk; 
	return length($chunk);
}

my $ip = '192.168.70.110';
my $pandora_url = '/pandora5';
my $apipass = '1234';
my $user = 'admin';
my $password = 'pandora';
my $op = 'get';
my $op2 = 'all_agents';
my $return_type = 'csv';
my $other = '';
my $other_mode = '';

my $url = "http://" . $ip  . $pandora_url . "/include/api.php";
$url .= "?";
$url .= "apipass=" . $apipass;
$url .= "&user=" . $user;
$url .= "&pass=" . $password;
$url .= "&op=" . $op;
$url .= "&op2=" . $op2;

my @body; 

my $curl = WWW::Curl::Easy->new;
$curl->setopt(CURLOPT_URL, $url);
$curl->setopt(CURLOPT_WRITEFUNCTION, \&write_callback);
$curl->setopt(CURLOPT_FILE, \@body); 
$curl->perform();

my $body=join("",@body); 
my @lines = split("\n", $body);

foreach my $line (@lines) {
	my @fields = split(';', $line);
	
	print("\n---- Agent #" . $fields[0] . " ----");
	print("\nName: " .  $fields[1]);
	print("\nIP: " .  $fields[2]);
	print("\nDescription: " . $fields[3]);
	print("\nOS: "  . $fields[4]);
	print("\n");
}

5.5 Ruby

require 'open-uri'

ip = '192.168.70.110'
pandora_url = '/pandora5'
apipass = '1234'
user = 'admin'
password = 'pandora'
op = 'get'
op2 = 'all_agents'
return_type = 'csv'
other = ''
other_mode = ''

url = "http://" + ip  + pandora_url + "/include/api.php"

url += "?"
url += "apipass=" + apipass
url += "&user="  + user
url += "&pass=" + password
url += "&op=" + op
url += "&op2=" + op2

agents = []

open(url) do |content|
	
	content.each do |line|
		agent = {}
		
		tokens = line.split(";")
		
		agent[:id_agent] = tokens[0]
		agent[:name] = tokens[1]
		agent[:ip] = tokens[2]
		agent[:description] = tokens[3]
		agent[:os_name] = tokens[4]
		agent[:url_address] = tokens[5]
		
		agents.push agent
	end
end


agents.each do |agent|
	print("---- Agent #" + (agent[:id_agent] || "") + " ----\n")
	print("Name: " + (agent[:name] || "") + "\n")
	print("IP: " + (agent[:ip] || "") + "\n")
	print("Description: " + (agent[:description] || "") + "\n")
	print("OS: " + (agent[:os_name] || "") + "\n")
	print("URL: " + (agent[:url_address] || "") + "\n")
	print("\n")
end

5.6 Lua

require("curl")

local content = "" 

function WriteMemoryCallback(s) 
	content = content .. s
	
	return string.len(s)
end

ip = '192.168.70.110'
pandora_url = '/pandora5'
apipass = '1234'
user = 'admin'
password = 'pandora'
op = 'get'
op2 = 'all_agents'
return_type = 'csv'
other = ''
other_mode = ''

url = "http://" .. ip  .. pandora_url .. "/include/api.php"

url = url .. "?"
url = url .. "apipass=" .. apipass
url = url .. "&user=" .. user
url = url .. "&pass=" .. password
url = url .. "&op=" .. op
url = url .. "&op2=" .. op2

if curl.new then c = curl.new() else c = curl.easy_init() end

c:setopt(curl.OPT_URL, url)
c:setopt(curl.OPT_WRITEFUNCTION, WriteMemoryCallback)

c:perform()

for line in string.gmatch(content, "[^\n]+") do
	line = string.gsub(line, "\n", "")
	
	count = 0
	for field in string.gmatch(line, "[^\;]+") do
		if count == 0 then
			print("---- Agent #" .. field .. " ----")
		end
		if count == 1 then
			print("Name: " .. field)
		end
		if count == 2 then
			print("IP: " .. field)
		end
		if count == 3 then
			print("Description: " .. field)
		end
		if count == 4 then
			print("OS: " .. field)
		end
		if count == 5 then
			print("URL: " .. field)
		end
		
		count = count + 1
	end
	print("")
end

5.7 Brainfuck

[-]>[-]<
>+++++++++[<+++++++++>-]<-.
>+++++[<+++++>-]<----.
>++++[<++++>-]<---.
>++++[<---->-]<++.
>+++[<+++>-]<++.
-.
>++++++++[<-------->-]<--.
>+++[<--->-]<---.
>++++++++[<++++++++>-]<++++.
+.
>++++++++[<-------->-]<-----.
>+++++++++[<+++++++++>-]<----.
++.
--.
>+++[<--->-]<+.
>+++[<+++>-]<.
>++[<++>-]<++.
>++[<-->-]<-.
>+++++++++[<--------->-]<++.
>+++++++++[<+++++++++>-]<---.
+.
>+++++++++[<--------->-]<++.
>+++++++++[<+++++++++>-]<+++.
>++++[<---->-]<+.
>+++[<+++>-]<.
>+++[<--->-]<++.
>+++[<+++>-]<-.
>+++++++++[<--------->-]<++.
>+++++++++[<+++++++++>-]<+++.
>+++[<--->-]<--.
----.
>+++[<+++>-]<-.
+++.
-.
>+++++++++[<--------->-]<++.
>+++++++++[<+++++++++>-]<-.
>++++[<---->-]<+.
>++++[<++++>-]<+.
>++++[<---->-]<-.
>++++++++[<-------->-]<-.
>++++++++[<++++++++>-]<++++++++.
>+++[<--->-]<++.
++.
++.
>++++[<++++>-]<---.
>++[<-->-]<--.
+++.
>++++++++[<-------->-]<---.
>+++[<--->-]<---.
>+++++++++[<+++++++++>-]<-.
>+++[<--->-]<--.
>++++[<++++>-]<---.
---.
>+++++++++[<--------->-]<++.
>+++++++++[<+++++++++>-]<+++++.
>+++++[<----->-]<++++.
>+++[<+++>-]<++.
>+++[<--->-]<++.
>++++++++[<-------->-]<-----.
>+++++++++[<+++++++++>-]<----.
>+++[<+++>-]<-.
>++++[<---->-]<--.
>++[<++>-]<+.
>+++[<+++>-]<--.
++++.
>+++++++++[<--------->-]<--.
>++++++++[<++++++++>-]<++++++.
>+++[<+++>-]<+++.
>+++[<--->-]<.
++.
--.
>+++[<+++>-]<--.
>++[<++>-]<+.
>+++[<--->-]<++.
>++[<++>-]<++.
>++[<-->-]<-.
++++.
>++++++++[<-------->-]<-----.

5.8 Java (Android)

Puedes ver nuestro proyecto (Pandroid Event Viewer) en Repositorio SVN de Pandroid Event Viewer source code en GitHub pero aquí esta el trozo de código más importante que realiza la llamada al API para sacar los eventos.

/**
	 * Performs an http get petition.
	 * 
	 * @param context
	 *            Application context.
	 * @param additionalParameters
	 *            Petition additional parameters
	 * @return Petition result.
	 * @throws IOException
	 *             If there is any problem with the connection.
	 */
	public static String httpGet(Context context,
			List<NameValuePair> additionalParameters) throws IOException {
		SharedPreferences preferences = context.getSharedPreferences(
				context.getString(R.string.const_string_preferences),
				Activity.MODE_PRIVATE);

		String url = preferences.getString("url", "") + "/include/api.php";
		String user = preferences.getString("user", "");
		String password = preferences.getString("password", "");
		String apiPassword = preferences.getString("api_password", "");
		if (url.length() == 0 || user.length() == 0) {
			return "";
		}
		ArrayList<NameValuePair> parameters = new ArrayList<NameValuePair>();
		parameters.add(new BasicNameValuePair("user", user));
		parameters.add(new BasicNameValuePair("pass", password));
		if (apiPassword.length() > 0) {
			parameters.add(new BasicNameValuePair("apipass", apiPassword));
		}
		parameters.addAll(additionalParameters);
		Log.i(TAG, "sent: " + url);
		if (url.toLowerCase().contains("https")) {
			// Secure connection
			return Core.httpsGet(url, parameters);
		} else {
			HttpParams params = new BasicHttpParams();
			HttpConnectionParams.setConnectionTimeout(params,
					CONNECTION_TIMEOUT);
			HttpConnectionParams.setSoTimeout(params, CONNECTION_TIMEOUT);
			DefaultHttpClient httpClient = new DefaultHttpClient(params);
			UrlEncodedFormEntity entity;
			HttpPost httpPost;
			HttpResponse response;
			HttpEntity entityResponse;
			String return_api;
			httpPost = new HttpPost(url);
			entity = new UrlEncodedFormEntity(parameters);
			httpPost.setEntity(entity);
			response = httpClient.execute(httpPost);
			entityResponse = response.getEntity();
			return_api = Core
					.convertStreamToString(entityResponse.getContent());
			Log.i(TAG, "received: " + return_api);
			return return_api;
		}
	}

6 Futuro del API.php

Algunas ideas para el futuro del api.php son:

  • Ampliar el conjunto de llamadas del API.
  • Devolver y recoger valores en xml, json...
  • Aumentar las securización de las llamadas para entornos inseguros.
  • Integrar con estándares de terceras herramientas.

Volver a Indice de Documentacion Pandora FMS