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

From Pandora FMS Wiki
Jump to: navigation, search
(Ejemplos)
(set access_process)
 
(544 intermediate revisions by 23 users not shown)
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 =
+
 
 +
= API Externa de Pandora FMS =
  
 
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 12: Line 13:
  
 
*op (obligatorio): es el primer parámetro. Especifica la naturaleza de la operación que puede ser "get" o "set" o "help:
 
*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
+
:*get: Devuelve un valor o valores
:*set: envía un valor o valores
+
:*set: Envía un valor o valores
:*help: devuelve una pequeña ayuda de las llamadas
+
:*help: Devuelve una pequeña ayuda de las llamadas
*op2 (obligatorio): la llamada en sí con un nombre explicativo de sobre que actua.
+
*op2 (obligatorio): La llamada en sí con un nombre explicativo de sobre que actua.
*id (opcional): primer parámetro de la llamada.
+
*id (opcional): Primer parámetro de la llamada.
*id2 (opcional): segundo 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 (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:
+
*other_mode (opcional): Formato de la serialización. Lista de valores posibles:
:*url_encode: el valor de other es un alfanumérico formateado como [http://en.wikipedia.org/wiki/Percent-encoding UrlEncode].
+
:*url_encode: El valor de other es un alfanumérico formateado como [http://en.wikipedia.org/wiki/Percent-encoding UrlEncode].
:*url_encode_separator_<separador>: el valor sera una lista de valores serializados con el carácter separador por ejemplo
+
:*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_|
 
  ...other=peras|melones|sandias&other_mode=url_encode_separator_|
*returnType (opcional): formato de retorno del valor o valores. Los valores disponibles actuales son:
+
*returnType (opcional): Formato de retorno del valor o valores. Los valores disponibles actuales son:
:*string: devuelve el valor tal cual como un alphanumerico.
+
:*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: 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
+
:*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 42: Line 42:
 
Para establecer la password hay que seguir los siguientes pasos:
 
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>):  
+
*''apipass'': Password del API que se configura desde la consola. Desde la siguiente vista de configuración (Administration>Setup>):  
  
 
<center><br><br>
 
<center><br><br>
Line 59: Line 59:
  
 
=== 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''.
  
  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>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>
  
 
Condiciones de acceso:  
 
Condiciones de acceso:  
Line 75: Line 73:
  
 
=== 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 89: Line 86:
  
 
==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 95: Line 91:
 
*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 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:
 
*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.
+
*id: Primer operador o parámetro, contiene un string.
*id2: segundo 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: Resto de operadores o parámetros, contenido como un array de dos posiciones:
:*$other['type']: que puede ser string o array.
+
:*$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.
+
:*$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.
+
*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 113: Line 108:
  
 
==== 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 130: Line 124:
  
 
==== 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"
  
  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>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 :
  
*returnError(typeError, returnType): devuelve un error de manera uniforme para todas las llamadas.
+
*returnError(typeError, returnType): Devuelve un error de manera uniforme para todas las llamadas.
:*typeError: de momento 'id_not_found' o null.
+
:*typeError: De momento 'id_not_found' o null.
:*returnType: de momento 'string' o mensaje de error.
+
:*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.
+
*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'
+
:*returnType: Que puede ser 'string', 'csv', 'csv_head'
:*data: es un array que contiene los datos asi como su formato, tiene los siguientes campos:
+
:*data: Es un array que contiene los datos asi como su formato, tiene los siguientes campos:
::*'type' (obligatorio): que puede ser 'string' y 'array'.
+
::*'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.
+
::*'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.
+
::*'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 183: Line 174:
  
 
==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.
  
Line 189: Line 179:
  
 
===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 196: Line 185:
 
La información que devuelve se puede obtener de la pantalla de login, por lo que no se considera que se vulnere la seguridad.  
 
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
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?info=version
 
+
</nowiki>
 
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.
 +
  
 
{{metaconsola}}
 
{{metaconsola}}
Line 213: Line 202:
  
 
=====Ejemplos=====
 
=====Ejemplos=====
 
 
Este ejemplo devolverá OK,[version],[build]
 
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
+
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?op=get&op2=test&apipass=1234&user=admin&pass=pandora
 
+
</nowiki>
 
Un ejemplo de respuesta podría ser: ''OK,v4.0.2,PC120614''
 
Un ejemplo de respuesta podría ser: ''OK,v4.0.2,PC120614''
  
Line 231: Line 219:
 
:*&lt;filter_group&gt;
 
:*&lt;filter_group&gt;
 
:*&lt;filter_module_states&gt;
 
:*&lt;filter_module_states&gt;
:*&lt;filter_name&gt;
+
:*&lt;filter_alias&gt;
 
:*&lt;filter_policy&gt;
 
:*&lt;filter_policy&gt;
 
:*&lt;csv_separator&gt;
 
:*&lt;csv_separator&gt;
 +
:*Recursión (<b>1</b> o <b>0</b>)
  
 
=====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 nombre contenga 'j', y su política asociada tenga id igual a 2.
+
  Ejemplo para CSV: <nowiki>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</nowiki>
 
+
Ejemplo para JSON: <nowiki>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
  Ejemplo para CSV: [http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=1|2|warning|j|2|~&other_mode=url_encode_separator_|
+
</nowiki>
&apipass=1234&user=admin&pass=pandora http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_agents&'''return_type=csv'''&other=1|2|warning|j|2|~&other_mode=url_encode_separator_|
 
&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=csv&other=1|2|warning|j|2|~&other_mode=url_encode_separator_|&apipass=1234
 
&user=admin&pass=pandora http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_agents&'''return_type=json'''&other=1|2|warning|j|2|~&other_mode=url_encode_separator_|
 
&apipass=1234&user=admin&pass=pandora]
 
  
 
====get module_last_value====
 
====get module_last_value====
Line 254: Line 238:
 
*op=get (obligatorio)
 
*op=get (obligatorio)
 
*op2=module_last_value (obligatorio)
 
*op2=module_last_value (obligatorio)
*id=&lt;índice&gt; (obligatorio) debe ser un índice de un modulo agente.
+
*id=&lt;índice&gt; (obligatorio): Debe ser un índice de un módulo agente.
*other=&lt;retorno error&gt; (opcional) que quieres que te devuelva si hay un error (no encontrado en DB el modulo normalmente).
+
*other=&lt;retorno error&gt; (opcional): Que quiere que le devuelva si hay un error (no encontrado en DB el módulo normalmente).
 
:*Códigos de retorno de error son:
 
:*Códigos de retorno de error son:
::*'error_message' devuelve error en un mensaje de texto.
+
::*'error_message': Devuelve error en un mensaje de texto.
::*'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=62&apipass=1234&user=admin&pass=pandora</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
+
====get agent_module_name_last_value====
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_last_value&id=62&apipass=1234&user=admin&pass=pandora
+
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 su aplicación detecte este valor fuera del rango de valores que puede tener el módulo.
 +
 
 +
Sintaxis de la llamada:
 +
 
 +
*op=get:(obligatorio)
 +
*op2=agent_module_name_last_value: (obligatorio)
 +
*id=&lt;alfanumerico&gt; (obligatorio):Contiene el nombre del agente.
 +
*id2=&lt;alfanumerico&gt; (obligatorio): Contiene el nombre del módulo.
 +
*other=&lt;retorno error&gt; (opcional): Que quiere que le 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'&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=====
 +
  <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====
+
====get agent_module_name_last_value_alias====
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.
+
>= 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:
 
Sintaxis de la llamada:
  
 
*op=get (obligatorio)
 
*op=get (obligatorio)
*op2=module_last_value (obligatorio)
+
*op2=agent_module_name_last_value_alias (obligatorio)
*id=&lt;alfanumerico&gt; (obligatorio) contiene el nombre del agente.
+
*id=&lt;alfanumerico&gt; (obligatorio): Contiene el alias del agente.
*id2=&lt;alfanumerico&gt; (obligatorio) contiene el nombre del modulo.
+
*id2=&lt;alfanumerico&gt; (obligatorio): Contiene el nombre del modulo.
*other=&lt;retorno error&gt; (opcional) que quieres que te devuelva si hay un error (no encontrado en DB el modulo normalmente).
+
*other=&lt;retorno error&gt; (opcional): Que quiere que lee devuelva si hay un error (no encontrado en DB el módulo normalmente).
 
:*Códigos de retorno de error son:
 
:*Códigos de retorno de error son:
::*'error_message' devuelve error en un mensaje de texto.
+
::*'error_message': Devuelve error en un mensaje de texto.
::*'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>
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=agent_module_name_last_value&id=miguel-portatil&id2=cpu_user&apipass=1234&user=admin&pass=pandora
 
  
 
====get module_value_all_agents====
 
====get module_value_all_agents====
Line 287: Line 288:
  
  
Síntaxis de la llamada:
+
Sintaxis de la llamada:
  
 
*op=get (obligatorio)
 
*op=get (obligatorio)
 
*op2=module_value_all_agents (obligatorio)
 
*op2=module_value_all_agents (obligatorio)
*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>
  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
 
  
 
====get agent_modules====
 
====get agent_modules====
Line 304: Line 304:
 
*op=get (obligatorio)
 
*op=get (obligatorio)
 
*op2=agent_modules (obligatorio)
 
*op2=agent_modules (obligatorio)
*return_type=&lt;csv&gt; (obligatorio) Formato de salida.
+
*return_type=&lt;csv&gt; (obligatorio): Formato de salida.
*other=&lt;valores serializados&gt; (obligatorio) Valores serializados para filtrar la búsqueda de módulos por agente:
+
*other=&lt;valores serializados&gt; (obligatorio): Valores serializados para filtrar la búsqueda de módulos por agente:
 
:*&lt;id_agent&gt;
 
:*&lt;id_agent&gt;
 
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>
  
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
+
====get module_id====
 +
Devuelve la id de un módulo concreto de un agente.
  
====get policies====
+
Sintaxis de la llamada:
Devuelve la lista políticas de un agente pasado su id dentro del parámetro other.
 
  
Síntaxis de llamada:
+
*op=get (obligatorio)
 +
*op2=module_id (obligatorio)
 +
*id= id del agente (obligatorio)
 +
*other=nombre del modulo (obligatorio)
 +
 
 +
=====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>
 +
 
 +
====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=&lt;csv&gt; (obligatorio) Formato de salida.
 +
*id=id_agent (obligatorio)
 +
*other_mode= other_mode=url_encode_separator_&lt;separador&gt (obligatorio)
 +
 
 +
=====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>
 +
 
 +
====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)
 
*op=get (obligatorio)
Line 325: Line 351:
  
 
=====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>
  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
 
  
 
====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 parametro 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.
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
Line 339: Line 364:
 
::*&lt;separador csv&gt;|&lt;carácter sustitución de retorno de carro&gt;|&lt;campos 1&gt;,&lt;campos 2&gt;,&lt;campos N&gt; se compondrá de los siguientes parámetros en orden (el carácter '|' de separación se puede especificar en "other_mode"):
 
::*&lt;separador csv&gt;|&lt;carácter sustitución de retorno de carro&gt;|&lt;campos 1&gt;,&lt;campos 2&gt;,&lt;campos N&gt; se compondrá de los siguientes parámetros en orden (el carácter '|' de separación se puede especificar en "other_mode"):
 
:::*&lt;separador csv&gt;: separador de los campos en el CSV.
 
:::*&lt;separador csv&gt;: separador de los campos en el CSV.
:::*&lt;caracter sustitución de retorno de carro&gt;: 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 estandar 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.
+
:::*&lt;caracter sustitución de retorno de carro&gt;: 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.
 
:::*&lt;campos 1&gt;,&lt;campos 2&gt;,&lt;campos N&gt : los campos a mostrar en el CSV y el orden en que mostrarlos, los posibles campos son:
 
:::*&lt;campos 1&gt;,&lt;campos 2&gt;,&lt;campos N&gt : los campos a mostrar en el CSV y el orden en que mostrarlos, los posibles campos son:
 
::::*type_row
 
::::*type_row
Line 351: Line 376:
 
::::*group_other
 
::::*group_other
 
::::*agent_id
 
::::*agent_id
::::*agent_name
+
::::*alias
 
::::*agent_direction
 
::::*agent_direction
 
::::*agent_comentary
 
::::*agent_comentary
Line 367: Line 392:
 
::::*agent_server_name
 
::::*agent_server_name
 
::::*agent_cascade_protection
 
::::*agent_cascade_protection
 +
::::*agent_name
 
::::*module_id_agent_modulo
 
::::*module_id_agent_modulo
 
::::*module_id_agent
 
::::*module_id_agent
Line 473: Line 499:
  
 
=====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>
  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>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>
  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
 
  
 
====get module_data====
 
====get module_data====
Line 484: Line 509:
 
*op2=module_data (obligatorio)
 
*op2=module_data (obligatorio)
 
*id=&lt;id_modulo&gt; (obligatorio)
 
*id=&lt;id_modulo&gt; (obligatorio)
*other=&lt;parámetros serializados&gt; (obligatorio), el carácter de separación del CSV y el periodo en segundo.
+
*other_mode=url_encode_separator_<separador> (obligatorio)
 +
*other=&lt;parámetros serializados&gt;(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>)
  
 
=====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>
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_data&id=17&other=;|604800&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
 
  
 
====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. Es necesario pasar el ancho, alto, periodo, nombre de la gráfica y fecha de comienzo, 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 506: Line 535:
  
 
=====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>
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=graph_module_data&id=17&other=604800|555|245|pepito|2009-12-07&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
 
  
 
====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.
  
{{metaconsola}}
+
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
Line 522: Line 550:
 
:*&lt;separator&gt;
 
:*&lt;separator&gt;
 
:*&lt;criticity&gt; de 0 a 4, o -1 como valor para evitar el parámetro
 
:*&lt;criticity&gt; de 0 a 4, o -1 como valor para evitar el parámetro
:*&lt;agent name&gt;
+
:*&lt;agent alias&gt;
 
:*&lt;module name&gt;  
 
:*&lt;module name&gt;  
 
:*&lt;alert template name&gt;
 
:*&lt;alert template name&gt;
Line 533: Line 561:
 
:*&lt;offset register&gt;
 
:*&lt;offset register&gt;
 
:*&lt;optional style [total|more_criticity]&gt; (total - retorna el total,  more_criticity - retorna los de mayor criticidad)
 
:*&lt;optional style [total|more_criticity]&gt; (total - retorna el total,  more_criticity - retorna los de mayor criticidad)
 +
:*&lt;id_grupo&gt;
 +
:*&lt;tags&gt;
 
:*&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>
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=events&return_type=csv&apipass=1234&user=admin&pass=pandora
+
  <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>
 
 
  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
 
  
 
====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.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
Line 552: Line 579:
  
 
=====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>
  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
 
  
 
====get module_groups====
 
====get module_groups====
Line 565: Line 591:
  
 
=====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>
  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
 
  
 
====get plugins====
 
====get plugins====
Devuelve la lista de plugins de servidor de Pandora.
+
Devuelve la lista de plugins de servidor de Pandora FMS.  
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
Line 578: Line 603:
  
 
=====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>
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=plugins&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
 
  
 
====get tags====
 
====get tags====
Line 590: Line 614:
  
 
=====Ejemplos=====
 
=====Ejemplos=====
 
 
Este ejemplo devolverá todos los tags del sistema.
 
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
+
  <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====
Line 607: Line 630:
  
 
=====Ejemplos=====
 
=====Ejemplos=====
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_from_conf&user=admin&pass=pandora&id=9043&id2=example_name
+
  <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
Line 620: Line 643:
  
 
=====Ejemplos=====
 
=====Ejemplos=====
  http://localhost/pandora_console/include/api.php?op=get&op2=total_modules&id=2&apipass=1234&user=admin&pass=pandora
+
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=total_modules&id=2&apipass=1234&user=admin&pass=pandora</nowiki>
  
  
Line 634: Line 657:
  
 
=====Ejemplos=====
 
=====Ejemplos=====
  http://localhost/pandora_console/include/api.php?op=get&op2=total_agents&id=2&apipass=1234&user=admin&pass=pandora
+
  <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====
Line 645: Line 668:
  
 
=====Ejemplos=====
 
=====Ejemplos=====
  http://localhost/pandora_console/include/api.php?op=get&op2=agent_name&id=1&apipass=1234&user=admin&pass=pandora
+
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=agent_name&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get module_name====
+
====get agent_alias====
Devuelve el nombre de un módulo dado su identificador.
+
>= 7.0NG
 +
 
 +
Devuelve el alias de un agente dado su identificador.
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=get (obligatorio)
 
*op=get (obligatorio)
*op2=module_name (obligatorio)
+
*op2=agent_alias (obligatorio)
*id=&lt;id modulo&gt; (obligatorio)
+
*id=&lt;id agente&gt; (obligatorio)
 +
*id2=<id del nodo> (obligatorio en la metaconsola, innecesario en el nodo)
  
 
=====Ejemplos=====
 
=====Ejemplos=====
http://localhost/pandora_console/include/api.php?op=get&op2=module_name&id=1&apipass=1234&user=admin&pass=pandora
+
* Nodo:
  
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=agent_alias&id=1&apipass=1234&user=admin&pass=pandora</nowiki>
  
====get alert_action_by_group====
+
* Metaconsola:
Devuelve el total de ejecuciones de alertas con una determinada acción por grupo.
+
 
 +
<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====
 +
Devuelve el nombre de un módulo dado su identificador.
 +
 
 +
Sintaxis de la llamada:
 +
*op=get (obligatorio)
 +
*op2=module_name (obligatorio)
 +
*id=&lt;id modulo&gt; (obligatorio)
 +
 
 +
=====Ejemplos=====
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=module_name&id=1&apipass=1234&user=admin&pass=pandora
 +
</nowiki>
 +
 
 +
====get alert_action_by_group====
 +
Devuelve el total de ejecuciones de alertas con una determinada acción por grupo.
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
Line 669: Line 712:
  
 
=====Ejemplos=====
 
=====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
+
  <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====
 +
Lista acciones de alertas
 +
 
 +
Sintaxis de la llamada:
 +
*op=get (obligatorio)
 +
*op2=alert_actions (obligatorio)
 +
*return_type=&lt;tipo retorno&gt; (obligatorio) que puede ser 'csv' o 'json'.
 +
*other=&lt;parámetros serializados&gt; (opcional):
 +
:*&lt;action_name&gt; (opcional)
 +
:*&lt;separator&gt; (opcional)
 +
 
 +
=====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>
 +
 
 +
====get alert_actions_meta====
 +
{{metaconsola}}
 +
Lista acciones de alertas de nodos desde la metaconsola.
 +
 
 +
Sintaxis de la llamada:
 +
*op=get (obligatorio)
 +
*op2=alert_actions_meta (obligatorio)
 +
*return_type=&lt;tipo retorno&gt; (obligatorio) que puede ser 'csv' o 'json'.
 +
*other=&lt;parámetros serializados&gt; (opcional):
 +
:*&lt;server_name&gt; (Opcional)
 +
:*&lt;action_name&gt; (opcional)
 +
:*&lt;separator&gt; (opcional)
 +
 
 +
=====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>
 +
 
 +
====get all_alert_commands====
 +
Devuelve todos los comandos de alertas.
 +
 
 +
Sintaxis de la llamada:
 +
*op=get (obligatorio)
 +
*op2=all_alert_commands (obligatorio)
 +
 
 +
=====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>
  
 
====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.
 +
  
 
{{metaconsola}}
 
{{metaconsola}}
Line 682: Line 766:
  
 
=====Ejemplos=====
 
=====Ejemplos=====
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=event_info&id=80&apipass=1234&user=admin&pass=pandora
+
  <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====
Line 720: Line 804:
  
 
=====Ejemplo=====
 
=====Ejemplo=====
  http://localhost/pandora_console/include/api.php?op=get&op2=tactical_view&apipass=1234&user=admin&pass=pandora
+
  <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
  
Devuelve la lista de servidores de pandora que hay.
+
Devuelve la lista de servidores de Pandora FMS que hay.
  
call syntax:
+
Sintaxis de la llamada:
 
*op=get (obligatorio)
 
*op=get (obligatorio)
 
*op2=pandora_servers (obligatorio)
 
*op2=pandora_servers (obligatorio)
Line 734: Line 818:
  
 
=====Example=====
 
=====Example=====
  http://localhost/pandora_console/include/api.php?op=get&op2=pandora_servers&return_type=csv&apipass=1234&user=admin&pass=pandora
+
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=pandora_servers&return_type=csv&apipass=1234&user=admin&pass=pandora</nowiki>
  
 
Devuelve los campos en el siguiente orden:
 
Devuelve los campos en el siguiente orden:
Line 741: Line 825:
 
*tipo (cadena legible por humanos)
 
*tipo (cadena legible por humanos)
 
*maestro (1 - maestro 0 - esclavo) ????
 
*maestro (1 - maestro 0 - esclavo) ????
*modulos en ejecucion
+
*módulos en ejecución
*modulos totales
+
*módulos totales
 
*max retardo (seg)
 
*max retardo (seg)
*modulos de retraso
+
*módulos de retraso
 
*hilos
 
*hilos
*modulos en cola
+
*módulos en cola
*fecha y hora de actualizacion (cadena legible por humanos)
+
*fecha y hora de actualización (cadena legible por humanos)
  
 
====get custom_field_id====
 
====get custom_field_id====
Line 761: Line 845:
  
 
=====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>
  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
 
  
 
====get gis_agent====
 
====get gis_agent====
Line 775: Line 858:
  
 
=====Ejemplo=====
 
=====Ejemplo=====
 
+
<nowiki>http://localhost/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=gis_agent&id=1</nowiki>
http://127.0.0.1/pandora5/include/api.php?apipass=caca&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%7Ccaca%7Cpis%7Cmierda
 
 
 
  
 
====get special_days====
 
====get special_days====
Line 791: Line 872:
  
 
=====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>
  http://127.0.0.1/pandora_console/include/api.php?apipass=1111&user=admin&pass=pandora&op=get&op2=special_days
 
  
 
====get module_properties====
 
====get module_properties====
 
>= 5.1SP2
 
>= 5.1SP2
  
Devuelve una lista de las propiedades del modulo. La lista podria ser filtrada por el parametro.
+
Devuelve una lista de las propiedades del módulo. La lista podría ser filtrada por el parámetro.  
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
Line 804: Line 884:
 
*id=<id_modulo> (obligatorio)
 
*id=<id_modulo> (obligatorio)
 
*return_type=&lt;tipo retorno&gt; (obligatorio) que puede ser 'csv' o 'csv_head'.
 
*return_type=&lt;tipo retorno&gt; (obligatorio) que puede ser 'csv' o 'csv_head'.
*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, vemos los dos casos:
+
*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, vemos los dos casos:
::*&lt;separador&gt; el separador si del 'csv'
+
::*&lt;separador&gt: El separador si del 'csv'
::*&lt;separador csv&gt;|&lt;caracter sustitucion de retorno de carro&gt;|&lt;campos 1&gt;,&lt;campos 2&gt;,&lt;campos N&gt; se compondra de los siguientes parametros en orden (el caracter '|' de separacion se puede especificar en "other_mode"):
+
::*&lt;separador csv&gt;|&lt;:caracter sustitución de retorno de carro&gt;|&lt;campos 1&gt;,&lt;campos 2&gt;,&lt;campos N&gt;: Se compondra de los siguientes parámetros en orden (el caracter '|' de separación se puede especificar en "other_mode"):
:::*&lt;separador csv&gt;: separador de los campos en el CSV.
+
:::*&lt;separador csv&gt;: Separador de los campos en el CSV.
:::*&lt;caracter sustitucion de retorno de carro&gt;: caracter que sustituira si encuentra en algun valor devuelto el caracter retorno de carro para evitar la ambiguedad con el uso estandar de retorno de carro para especificar registros/filas en el CSV. Si se pasa un string en other, el caracter sustituto es el espacio en blanco.
+
:::*&lt;caracter sustitucion de retorno de carro&gt;: 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.
:::*&lt;campos 1&gt;,&lt;campos 2&gt;,&lt;campos N&gt : los campos a mostrar en el CSV y el orden en que mostrarlos, los posibles campos son:
+
:::*&lt;campos 1&gt;,&lt;campos 2&gt;,&lt;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_modulo
 
::::*module_id_agent
 
::::*module_id_agent
Line 861: Line 941:
  
 
=====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>
  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>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
  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>
  
 
====get module_properties_by_name====
 
====get module_properties_by_name====
 
>= 5.1SP2
 
>= 5.1SP2
  
Devuelve una lista de las propiedades del modulo. La lista podria ser filtrada por el parametro.
+
Devuelve una lista de las propiedades del módulo. La lista podria ser filtrada por el parámetro.
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
Line 879: Line 959:
  
 
=====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=;|%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====
 +
>= 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=&lt;tipo retorno&gt; (obligatorio) que puede ser 'csv' o 'csv_head'.
 +
*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.
  
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
+
=====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=;|%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>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>
  
 
====get module_graph====
 
====get module_graph====
Line 895: Line 991:
  
 
=====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
  http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_graph&id=1&other=3600&apipass=1234&user=admin&pass=pandora
+
</nowiki>
  
 
====get all_planned_downtimes====
 
====get all_planned_downtimes====
Line 911: Line 1,007:
  
 
=====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
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=all_planned_downtimes&other=test|0|quiet|periodically|weekly
+
</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>
&other_mode=url_encode_separator_|&return_type=json
 
 
 
OR
 
 
 
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
 
  
 
====get planned_downtimes_items====
 
====get planned_downtimes_items====
Line 932: Line 1,022:
  
 
=====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> <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>
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_items&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=json
+
====get id_group_agent_by_name====
 +
>= 5.1
  
O
+
Retorna el id de grupo de un agente.
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_items&other=test|0|quiet|periodically|weekly&other_mode=url_encode_separator_|&return_type=csv
+
Sintaxis de la llamada:
 +
 
 +
* op=get
 +
* op2=id_group_agent_by_name
 +
* other=<parámetros serializados> (opcional) parámetros para filtrar, serializados:
 +
:* <nombre_agente>
  
 +
=====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>
  
====get id_group_agent_by_name====
+
====get id_group_agent_by_alias====
>= 5.1
+
>= 7.0NG
  
 
Retorna el id de grupo de un agente.
 
Retorna el id de grupo de un agente.
Line 948: Line 1,050:
  
 
* op=get
 
* op=get
* op2=id_group_agent_by_name
+
* op2=id_group_agent_by_alias
 
* other=<parámetros serializados> (opcional) parámetros para filtrar, serializados:
 
* other=<parámetros serializados> (opcional) parámetros para filtrar, serializados:
:* <nombre_agente>
+
:* <alias_agente>
  
 
=====Ejemplo=====
 
=====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
+
  <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>
  
 
====get group_agent_by_name====
 
====get group_agent_by_name====
Line 968: Line 1,071:
  
 
=====Ejemplo=====
 
=====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
+
  <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>
  
===SET===
+
====get group_agent_by_alias====
 +
>= 7.0NG
  
Envia los datos.
+
Retorna el nombre de grupo de un agente.
  
====set new_agent====
+
Sintaxis de la llamada:
Crea un nuevo agente con los datos pasados como parámetros.
 
  
Sintaxis de la llamada:
+
* op=get
*op=set (obligatorio)
+
* op2=group_agent_by_alias
*op2=new_agent (obligatorio)
+
* other=<parámetros serializados> (opcional) parámetros para filtrar, serializados:
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del agente, serializados en el siguiente orden:
+
:* <alias_agente>
:*&lt;nombre_agente&gt;
 
:*&lt;ip&gt;
 
:*&lt;id_parent&gt;
 
:*&lt;id_group&gt;
 
:*&lt;cascade_protection&gt;
 
:*&lt;interval_sec&gt;
 
:*&lt;id_os&gt;
 
:*&lt;name_server&gt;
 
:*&lt;custom_id&gt;
 
:*&lt;learning_mode&gt;
 
:*&lt;disabled&gt;
 
:*&lt;description&gt;
 
  
=====Ejemplos=====
+
=====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?op=set&op2=new_agent&other=agente_nombre|1.1.1.1|0|4|0|localhost.localdomain|8|10||0|0|la%20descripcion&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
+
====get group_id_by_name====
 +
>= 7.0NG
  
====set update_agent====
+
Retorna el id de grupo a partir del nombre.
Actualiza el agente con los datos pasados como parámetros.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
*op=set (obligatorio)
 
*op2=new_agent (obligatorio)
 
*id=&lt;id_agente&gt; (obligatorio)
 
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del agente, serializados en el siguiente orden:
 
:*&lt;nombre_agente&gt;
 
:*&lt;ip&gt;
 
:*&lt;id_parent&gt;
 
:*&lt;id_group&gt;
 
:*&lt;cascade_protection&gt;
 
:*&lt;interval_sec&gt;
 
:*&lt;id_os&gt;
 
:*&lt;name_server&gt;
 
:*&lt;custom_id&gt;
 
:*&lt;learning_mode&gt;
 
:*&lt;disabled&gt;
 
:*&lt;description&gt;
 
  
=====Ejemplos=====
+
* op=get
 +
* op2=group_id_by_name
 +
* other=<parámetros único> (obligatorio):
 +
:* <group_name>
  
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_agent&other=agente_nombre|1.1.1.1|0|4|0|30|8|localhost.localdomain||0|0|la%20descripcion&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
+
=====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>
  
====set delete_agent====
+
====get timezone====
 +
>= 7.0NG
  
Elimina un agente pasando el nombre como parámetro.
+
Retorna el timezone con el que está configurado Pandora FMS.
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
*op=set (obligatorio)
 
*op2=delete_agent (obligatorio)
 
*id=&lt;nombre_agente&gt; (obligatorio) debe ser un nombre agente.
 
  
=====Ejemplos=====
+
* op=get
 +
* op2=timezone
 +
 
 +
=====Ejemplo=====
 +
<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====
 +
>= 7.0
 +
 
 +
Obtener estado del cluster a partir del id
 +
 
 +
*op=get
 +
*op2=cluster_status
 +
*id=id del cluster
 +
 
 +
  <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====
 +
>= 7.0
 +
 
 +
Obtener id de cluster a partir del nombre
 +
 
 +
*op=get
 +
*op2=cluster_id_by_name
 +
*id=nombre del cluster
 +
 
 +
  <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====
 +
>= 7.0
 +
 
 +
Obtener los id => nombres de los agentes del cluster a partir del id de cluster
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_agent&id=agente_erroneo&apipass=1234&user=admin&pass=pandora
+
*op=get
 +
*op2=agents_id_name_by_cluster_id
 +
*id=id del cluster
  
====set create_module_template====
+
  <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>
  
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.
+
====get agents_id_name_by_cluster_name====
 +
>= 7.0
  
Sintaxis de llamada:
+
Obtener los id => nombres de los agentes del cluster a partir del nombre de cluster
*op=set (obligatorio)
 
*op2=create_module_template (obligatorio)
 
*id=&lt;id_template&gt; (obligatorio) debe ser un id de template.
 
*other=&lt;id_modulo&gt;|&lt;id_agente&gt;
 
  
=====Ejemplos=====
+
*op=get
 +
*op2=agents_id_name_by_cluster_name
 +
*id=id del cluster
  
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>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>
  
====set create_network_module====
+
====get modules_id_name_by_cluster_id====
Crea un módulo de red con los datos pasados como parámetros.
+
>= 7.0
  
Sintaxis de la llamada:
+
Obtener los id => nombres de todos los módulos de los agentes del cluster a partir del id del cluster
*op=set (obligatorio)
+
 
*op2=create_network_module (obligatorio)
+
*op=get
*id=&lt;nombre_agente&gt; (obligatorio) debe ser un nombre agente.
+
*op2=modules_id_name_by_cluster_id
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
+
*id=id del cluster
:*&lt;name_module&gt;
+
 
:*&lt;disabled&gt;
+
  <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>
:*&lt;id_module_type&gt;
+
 
:*&lt;id_module_group&gt;
+
====get modules_id_name_by_cluster_name====
:*&lt;min_warning&gt;
+
>= 7.0
:*&lt;max_warning&gt;
+
 
:*&lt;str_warning&gt;
+
Obtener los id => nombres de todos los módulos de los agentes del cluster a partir del nombre del cluster
:*&lt;min_critical&gt;
+
 
:*&lt;max_critical&gt;
+
*op=get
:*&lt;str_critical&gt;
+
*op2=modules_id_name_by_cluster_name
:*&lt;ff_threshold&gt;
+
*id=id del cluster
:*&lt;history_data&gt;
+
 
:*&lt;ip_target&gt;
+
  <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>
:*&lt;tcp_port&gt;
+
 
:*&lt;snmp_community&gt;
+
====get cluster_items====
:*&lt;snmp_oid&gt;
+
>= 7.0
:*&lt;module_interval&gt;
+
 
:*&lt;post_process&gt;
+
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
:*&lt;min_value&gt;
+
 
:*&lt;max_value&gt;
+
pcrit: % para estado critico si es AA y 1 o 0 si es AP
:*&lt;custom_id&gt;
+
 
:*&lt;description&gt;
+
pwarn: % para estado warning si es AP y nulo si es AP
:*&lt;enable_unknown_events&gt; (solo versión 5)
+
 
:*&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>"''.
+
*op=get
:*&lt;each_ff&gt; (solo version 5.1)
+
*op2=cluster_items
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
+
*id=id del cluster
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 
:*&lt;critical_inverse&gt; (solo versión 6.0SP1)
 
:*&lt;warning_inverse&gt; (solo versión 6.0SP1)
 
  
=====Ejemplos=====
+
  <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>
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_network_module&id=pepito&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
+
====get policy====
 +
>= 7.0NG. 725
  
====set create_plugin_module====
+
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.  
Crea un módulo de tipo plugin con los datos pasados como parámetros.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
*op=set (obligatorio)
+
 
*op2=create_plugin_module (obligatorio)
+
* op=get
*id=&lt;nombre_agente&gt; (obligatorio) debe ser un nombre agente.
+
* op2=policy
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
+
* id=id_policy (opcional)
:*&lt;name_module&gt;
+
* return_type=(json, csv, string).
:*&lt;disabled&gt;
+
 
:*&lt;id_module_type&gt;
 
:*&lt;id_module_group&gt;
 
:*&lt;min_warning&gt;
 
:*&lt;max_warning&gt;
 
:*&lt;str_warning&gt;
 
:*&lt;min_critical&gt;
 
:*&lt;max_critical&gt;
 
:*&lt;str_critical&gt;
 
:*&lt;ff_threshold&gt;
 
:*&lt;history_data&gt;
 
:*&lt;ip_target&gt;
 
:*&lt;tcp_port&gt;
 
:*&lt;snmp_community&gt;
 
:*&lt;snmp_oid&gt;
 
:*&lt;module_interval&gt;
 
:*&lt;post_process&gt;
 
:*&lt;min_value&gt;
 
:*&lt;max_value&gt;
 
:*&lt;custom_id&gt;
 
:*&lt;description&gt;
 
:*&lt;id_plugin&gt;
 
:*&lt;plugin_user&gt;
 
:*&lt;plugin_pass&gt;
 
:*&lt;plugin_parameter&gt;
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
 
:*&lt;macros&gt; (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).
 
 
=====Ejemplo=====
 
=====Ejemplo=====
  {
+
  <nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
  "1": {
+
 
    "macro": "_field1_",
+
====get collections_policy====
    "desc": "Target&#x20;IP",
+
>= 7.0NG. 725
    "help": "",
+
 
    "value": "192.168.0.1",
+
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.  
    "hide": ""
 
  },
 
  "2": {
 
    "macro": "_field2_",
 
    "desc": "Port",
 
    "help": "",
 
    "value": "80",
 
    "hide": ""
 
  }
 
}
 
:*&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;each_ff&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 
:*&lt;critical_inverse&gt; (solo versión 6.0SP1)
 
:*&lt;warning_inverse&gt; (solo versión 6.0SP1)
 
  
=====Ejemplos=====
+
Sintaxis de la llamada:
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_plugin_module&id=pepito&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
+
* op=get
 +
* op2=collections_policy
 +
* id=id_policy (opcional)
 +
* return_type=(json, csv, string).
  
====set create_data_module====
+
=====Ejemplo=====
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=collections_policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
  
Crea un módulo con los parámetros pasados.
+
====get plugins_policy====
 +
>= 7.0NG. 725
  
{{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}}
+
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).
 +
 
 +
=====Ejemplo=====
 +
<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====
 +
>= 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:
 
Sintaxis de la llamada:
*op=set (obligatorio)
 
*op2=create_data_module (obligatorio)
 
*id=&lt;nombre_agente&gt; (obligatorio) debe ser un nombre agente.
 
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
 
:*&lt;name_module&gt;
 
:*&lt;disabled&gt;
 
:*&lt;id_module_type&gt;
 
:*&lt;description&gt;
 
:*&lt;id_module_group&gt;
 
:*&lt;min_value&gt;
 
:*&lt;max_value&gt;
 
:*&lt;post_process&gt;
 
:*&lt;module_interval&gt;
 
:*&lt;min_warning&gt;
 
:*&lt;max_warning&gt;
 
:*&lt;str_warning&gt;
 
:*&lt;min_critical&gt;
 
:*&lt;max_critical&gt;
 
:*&lt;str_critical&gt;
 
:*&lt;history_data&gt;
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
 
:*&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;ff_threshold&gt; (solo versión 5.1)
 
:*&lt;each_ff&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 
:*&lt;ff_timeout&gt; (solo versión 5.1)
 
:*&lt;critical_inverse&gt; (solo versión 6.0SP1)
 
:*&lt;warning_inverse&gt; (solo versión 6.0SP1)
 
  
=====Ejemplos=====
+
* op=get
 +
* op2=inventory_policy
 +
* id=id_policy (opcional)
 +
* return_type=(json, csv, string).
  
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_data_module&id=pepito&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
+
=====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>
  
====set create_SNMP_module====
+
====get unlinking_policy====
 +
>= 7.0NG. 725
  
Crea un módulo SNMP.
+
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:
 
Sintaxis de la llamada:
*op=set (obligatorio)
 
*op2=create_snmp_module (obligatorio)
 
*id=&lt;nombre_agente&gt; (obligatorio) debe ser un nombre agente.
 
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
 
:*&lt;name_module&gt;
 
:*&lt;disabled&gt;
 
:*&lt;id_module_type&gt;
 
:*&lt;id_module_group&gt;
 
:*&lt;min_warning&gt;
 
:*&lt;max_warning&gt;
 
:*&lt;str_warning&gt;
 
:*&lt;min_critical&gt;
 
:*&lt;max_critical&gt;
 
:*&lt;str_critical&gt;
 
:*&lt;ff_threshold&gt;
 
:*&lt;history_data&gt;
 
:*&lt;ip_target&gt;
 
:*&lt;module_port&gt;
 
:*&lt;snmp_version&gt;
 
:*&lt;snmp_community&gt;
 
:*&lt;snmp_oid&gt;
 
:*&lt;module_interval&gt;
 
:*&lt;post_process&gt;
 
:*&lt;min_value&gt;
 
:*&lt;max_value&gt;
 
:*&lt;custom_id&gt;
 
:*&lt;description&gt;
 
:*&lt;snmp3_priv_method [AES|DES]&gt;
 
:*&lt;snmp3_priv_pass&gt;
 
:*&lt;snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv]&gt;
 
:*&lt;snmp3_auth_method [MD5|SHA]&gt;
 
:*&lt;snmp3_auth_user&gt;
 
:*&lt;snmp3_auth_pass&gt;
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
 
:*&lt;each_ff&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 
  
=====Ejemplos=====
+
* op=get
 +
* op2=unlinking_policy
 +
* id=id_policy(opcional)
 +
* return_type=(json, csv, string).
 +
 
 +
=====Ejemplo=====
 +
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=unlinking_policy&apipass=1234&user=admin&pass=pandora&return_type=json.</nowiki>
  
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)
+
====get alerts_policy====
 +
>= 7.0NG. 725
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_snmp_module&id=pepito&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
+
Devuelve las alertas asociadas a una política teniendo en cuenta:
  
Ejemplo 2 (snmp v: 1)
+
* 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).
 +
 
 +
=====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>
 +
 
 +
====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).
 +
 
 +
=====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>
 +
 
 +
====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:
  
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
+
* op = get
 +
* op2 = agents_policy
 +
* id = id_policy(opcional)
 +
* return_type = (json, csv, string).
  
====set update_network_module====
+
=====Ejemplo=====
 +
<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====
 +
>= 7.0NG. 725
  
Actualiza la configuración de un módulo de red.
+
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:
 
Sintaxis de la llamada:
*op=set (obligatorio)
 
*op2=update_network_module (obligatorio)
 
*id=&lt;id_modulo&gt; (obligatorio) debe ser el ID numérico del módulo (tagente_modulo)
 
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
 
:*&lt;id_agent&gt;
 
:*&lt;disabled&gt;
 
:*&lt;id_module_group&gt;
 
:*&lt;min_warning&gt;
 
:*&lt;max_warning&gt;
 
:*&lt;str_warning&gt;
 
:*&lt;min_critical&gt;
 
:*&lt;max_critical&gt;
 
:*&lt;str_critical&gt;
 
:*&lt;ff_threshold&gt;
 
:*&lt;history_data&gt;
 
:*&lt;ip_target&gt;
 
:*&lt;tcp_port&gt;
 
:*&lt;snmp_community&gt;
 
:*&lt;snmp_oid&gt;
 
:*&lt;module_interval&gt;
 
:*&lt;post_process&gt;
 
:*&lt;min_value&gt;
 
:*&lt;max_value&gt;
 
:*&lt;custom_id&gt;
 
:*&lt;description&gt;
 
:*&lt;disabled_types_event&gt; (solo versión 5)
 
:*&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;each_ff&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 
:*&lt;critical_inverse&gt; (solo versión 6.0SP1)
 
:*&lt;warning_inverse&gt; (solo versión 6.0SP1)
 
  
=====Ejemplos=====
+
* op = get
 +
* op2 = groups_policy
 +
* id = id_policy(opcional)
 +
* return_type = (json, csv, string).
 +
 
 +
=====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>
 +
 
 +
====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).
 +
 
 +
=====Ejemplo=====
 +
<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====
 +
>= 7.0NG. 728
 +
 
 +
Devuelve los traps de origen especificado, también puedes filtrar por timestamp y otros datos.
 +
 
 +
Sintaxis de la llamada:
  
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
+
* op = get
 +
* op2 = traps
 +
* other=<parámetros opcionales>:
 +
:* <timestamp>
 +
:* <limit>
 +
:* <offset>
 +
:* <status>
 +
:* <oid_custom>
  
====set update_plugin_module====
+
=====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>
  
Actualiza la configuración de un módulo plugin.
+
====get event_responses====
 +
Devuelve la lista de respuesta de eventos a las que el usuario tiene acceso en Pandora FMS.
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
*op=set (obligatorio)
+
*op=get (obligatorio)
*op2=update_plugin_module (obligatorio)
+
*op2=event_reponses (obligatorio)
*id=&lt;nombre_modulo&gt; (obligatorio) debe ser el ID numérico del módulo a actualizar (tagente_modulo)
+
*return_type=csv|json (obligatorio)
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
+
 
:*&lt;id_agent&gt;
 
:*&lt;disabled&gt;
 
:*&lt;id_module_group&gt;
 
:*&lt;min_warning&gt;
 
:*&lt;max_warning&gt;
 
:*&lt;str_warning&gt;
 
:*&lt;min_critical&gt;
 
:*&lt;max_critical&gt;
 
:*&lt;str_critical&gt;
 
:*&lt;ff_threshold&gt;
 
:*&lt;history_data&gt;
 
:*&lt;ip_target&gt;
 
:*&lt;tcp_port&gt;
 
:*&lt;snmp_community&gt;
 
:*&lt;snmp_oid&gt;
 
:*&lt;module_interval&gt;
 
:*&lt;post_process&gt;
 
:*&lt;min_value&gt;
 
:*&lt;max_value&gt;
 
:*&lt;custom_id&gt;
 
:*&lt;description&gt;
 
:*&lt;id_plugin&gt;
 
:*&lt;plugin_user&gt;
 
:*&lt;plugin_pass&gt;
 
:*&lt;plugin_parameter&gt;
 
:*&lt;disabled_types_event&gt; (solo versión 5)
 
:*&lt;macros&gt; (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.
 
 
=====Ejemplo=====
 
=====Ejemplo=====
{
+
Este ejemplo devolverá todas las respuestas de eventos del sistema en formato csv.
  "1": {
+
 
    "macro": "_field1_",
+
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=event_responses&return_type=csv&apipass=1234&user=admin&pass=pandora</nowiki>
    "desc": "Target&#x20;IP",
+
 
    "help": "",
+
====get users====
    "value": "192.168.0.1"
+
Devuelve la lista de los usuario de Pandora FMS.
  },
+
 
  "2": {
+
Sintaxis de la llamada:
    "macro": "_field2_",
+
*op=get (obligatorio)
    "desc": "Port",
+
*op2=users (obligatorio)
    "help": "",
+
*return_type=csv|json (obligatorio)
    "value": "80"
+
 
  }
+
=====Ejemplo=====
}
+
Este ejemplo devolverá todos usuario del sistema en formato csv.
:*&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;each_ff&gt; (solo versión 5.1)
+
<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>
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 
:*&lt;critical_inverse&gt; (solo versión 6.0SP1)
 
:*&lt;warning_inverse&gt; (solo versión 6.0SP1)
 
  
=====Ejemplos=====
+
====get list all user====
 +
{{metaconsola}}
 +
Listar todos los usuarios de Pandora FMS
  
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
+
Sintaxis de la llamada:
 +
*op=get (obligatorio)
 +
*op2=list_all_user (obligatorio)
 +
*return_type=csv|json (obligatorio)
  
====set update_data_module====
+
=====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
  
<br>
+
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=list_all_user&return_type=json&apipass=1234&user=admin&pass=pandora</nowiki>
{{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}}
 
  
Actualiza un módulo local.
+
====get info user name====
 +
{{metaconsola}}
 +
Lista la informacion de un usuario
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
*op=set (obligatorio)
+
*op=get (obligatorio)
*op2=update_data_module (obligatorio)
+
*op2=info_user_name (obligatorio)
*id=&lt;id_agent_module&gt; (obligatorio) debe ser el ID numérico del modulo a actualizar.
+
*return_type=csv|json (obligatorio)
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
+
*other=nombre de usuario(obligatorio)
:*&lt;id_agent&gt;
+
 
:*&lt;disabled&gt;
+
=====Ejemplo=====
:*&lt;id_module_group&gt;
+
Obtenemos toda la información de un usuario específico
:*&lt;min_warning&gt;
+
Puede retornar Json o CSV, este retorno se indica mediante la URL
:*&lt;max_warning&gt;
+
Usamos unicamente el nombre del usuario para obtener dicha información:
:*&lt;str_warning&gt;
+
 
:*&lt;min_critical&gt;
+
<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>
:*&lt;max_critical&gt;
+
 
:*&lt;str_critical&gt;
+
====get user_profiles_info====
:*&lt;ff_threshold&gt;
+
Devuelve la lista de los perfiles de usuario de Pandora FMS.
:*&lt;history_data&gt;
 
:*&lt;ip_target&gt;
 
:*&lt;module_port&gt;
 
:*&lt;snmp_community&gt;
 
:*&lt;snmp_oid&gt;
 
:*&lt;module_interval&gt;
 
:*&lt;post_process&gt;
 
:*&lt;min_value&gt;
 
:*&lt;max_value&gt;
 
:*&lt;custom_id&gt;
 
:*&lt;description&gt;
 
:*&lt;disabled_types_event&gt; (solo versión 5)
 
:*&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;ff_threshold&gt; (solo versión 5.1)
 
:*&lt;each_ff&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 
:*&lt;ff_timeout&gt; (solo versión 5.1)
 
:*&lt;critical_inverse&gt; (solo versión 6.0SP1)
 
:*&lt;warning_inverse&gt; (solo versión 6.0SP1)
 
  
=====Ejemplos=====
+
Sintaxis de la llamada:
 +
*op=get (obligatorio)
 +
*op2=user_profiles_info (obligatorio)
 +
*return_type=csv|json (obligatorio)
  
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
+
=====Ejemplo=====
 +
Este ejemplo devolverá todos los perfiles de usuario del sistema en formato json.
  
====set update_SNMP_module====
+
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=user_profiles_info&return_type=json&apipass=1234&user=admin&pass=pandora</nowiki>
  
Actualiza un módulo SNMP.
+
====get migrate_agent====
 +
>= 7.21 ONLY METACONSOLE
  
Sintaxis de la llamada:
+
Mira si existe en la cola de migración de agentes un agente determinado devolviendo los datos de tmigration_queue
*op=set (obligatorio)
 
*op2=update_snmp_module (obligatorio)
 
*id=&lt;id_module&gt; (obligatorio) debe ser un ID numérico de módulo.
 
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
 
:*&lt;id_agent&gt;
 
:*&lt;disabled&gt;
 
:*&lt;id_module_group&gt;
 
:*&lt;min_warning&gt;
 
:*&lt;max_warning&gt;
 
:*&lt;str_warning&gt;
 
:*&lt;min_critical&gt;
 
:*&lt;max_critical&gt;
 
:*&lt;str_critical&gt;
 
:*&lt;ff_threshold&gt;
 
:*&lt;history_data&gt;
 
:*&lt;ip_target&gt;
 
:*&lt;module_port&gt;
 
:*&lt;snmp_version&gt;
 
:*&lt;snmp_community&gt;
 
:*&lt;snmp_oid&gt;
 
:*&lt;module_interval&gt;
 
:*&lt;post_process&gt;
 
:*&lt;min_value&gt;
 
:*&lt;max_value&gt;
 
:*&lt;custom_id&gt;
 
:*&lt;description&gt;
 
:*&lt;snmp3_priv_method [AES|DES]&gt;
 
:*&lt;snmp3_priv_pass&gt;
 
:*&lt;snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv]&gt;
 
:*&lt;snmp3_auth_method [MD5|SHA]&gt;
 
:*&lt;snmp3_auth_user&gt;
 
:*&lt;snmp3_auth_pass&gt;
 
:*&lt;disabled_types_event&gt; (solo versión 5)
 
:*&lt;each_ff&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 
  
=====Ejemplos=====
+
*op=get
 +
*op2=migrate_agent
 +
*id=id_agente a migrar
 +
*return_type = string, json, etc
  
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)
+
=====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>
 +
 
 +
====get language====
 +
>= 7.0NG 730
 +
 
 +
Retorna el idioma con el que está configurado Pandora FMS.
 +
 
 +
Sintaxis de la llamada:
 +
 
 +
* op=get
 +
* op2=language
  
  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|pepito_user|example_auth_passw&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
+
=====Ejemplo=====
 +
  <nowiki>http://127.0.0.1/pandora_console/include/api.php?apipass=1234&user=admin&pass=pandora&op=get&op2=language</nowiki>
  
====set apply_policy====
+
====get session_timeout====
 +
>= 7.0NG 730
  
Aplica la política pasada por su id en el parámetro id.
+
Retorna el tiempo de sesión con el que está configurado Pandora FMS.
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
*op=set (obligatorio)
 
*op2=apply_policy (obligatorio)
 
*id=&lt;id_policy&gt; (obligatorio) debe ser el Id de la política.
 
  
=====Ejemplos=====
+
* op=get
 +
* op2=session_timeout
 +
 
 +
=====Ejemplo=====
 +
<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====
 +
Retorna los grupos existentes.
 +
 
 +
Sintaxis de la llamada:
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_policy&id=1&apipass=1234&user=admin&pass=pandora
+
* 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.
  
====set apply_all_policies====
+
=====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>
  
Aplica todas las políticas que contiene Pandora.
+
====get filter user group====
 +
{{metaconsola}}
 +
Obtener grupos de usuario mediante filtrado.
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
*op=set (obligatorio)
 
*op2=apply_all_policies (obligatorio)
 
  
=====Ejemplos=====
+
* op=get (obligatorio)
 +
* op2=filter_user_group (obligatorio)
 +
* return_type=csv|json(obligatorio)
 +
*other= id group(obligatorio)|Habilitado o no(Disabled)(obligatorio)
 +
 
 +
=====Ejemplo=====
 +
Puede retornar Json o CSV, este retorno se indica mediante la URL.
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=apply_all_policies&apipass=1234&user=admin&pass=pandora
+
{{Warning|Puedes tener una de las dos variables (id grupo o Habilitado) vacías, pero tiene que tener mínimo una de ellas.}}
  
====set add_network_module_policy====
+
<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>
  
Añade un módulo de red en la política pasada por id en el parámetro.
+
====get inventory_modules====
 +
Devuelve la lista de los módulos de inventario de Pandora FMS.
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
*op=set (obligatorio)
+
*op=get (obligatorio)
*op2=add_network_module_policy (obligatorio)
+
*op2=inventory_modules (obligatorio)
*id=&lt;id_politica&gt; (obligatorio) debe ser un Id de política
+
*return_type=csv|json (obligatorio)
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
+
 
:*&lt;name_module&gt;
+
=====Ejemplos=====
:*&lt;id_module_type&gt;
+
Este ejemplo devolverá información de todos los de inventario del sistema en formato json.
:*&lt;description&gt;
+
 
:*&lt;id_module_group&gt;
+
<nowiki>http://localhost/pandora_console/include/api.php?op=get&op2=inventory_modules&return_type=json&apipass=1234&user=admin&pass=pandora</nowiki>
:*&lt;min_value&gt;
+
 
:*&lt;max_value&gt;
+
====get inventory_modules_by_name====
:*&lt;post_process&gt;
+
Lista los módulos de inventario de un agente utilizando nombre de agente.
:*&lt;module_interval&gt;
+
 
:*&lt;min_warning&gt;
+
Sintaxis de la llamada:
:*&lt;max_warning&gt;
+
*op=get (obligatorio)
:*&lt;str_warning&gt;
+
*op2=inventory_modules_by_name (obligatorio)
:*&lt;min_critical&gt;
+
*id=<nombre de agente> (obligatorio)
:*&lt;max_critical&gt;
 
:*&lt;str_critical&gt;
 
:*&lt;history_data&gt;
 
:*&lt;ff_threshold&gt;
 
:*&lt;disabled&gt;
 
:*&lt;module_port&gt;
 
:*&lt;snmp_community&gt;
 
:*&lt;snmp_oid&gt;
 
:*&lt;custom_id&gt;
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
 
:*&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;each_ff&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 
  
 
=====Ejemplos=====
 
=====Ejemplos=====
 +
http://localhost/pandora_console/include/api.phpop=get&op2=inventory_modules_by_name&id=name&return_type=csv&apipass=1234&user=admin&pass=pandora
  
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
+
====get inventory_modules_by_alias====
 +
Lista los módulos de inventario de un agente utilizando alias de agente.
  
====set add_plugin_module_policy====
+
Sintaxis de la llamada:
 +
*op=get (obligatorio)
 +
*op2=inventory_modules_by_alias (obligatorio)
 +
*id=<alias de agente> (obligatorio)
 +
 
 +
=====Ejemplos=====
 +
http://localhost/pandora_console/include/api.phpop=get&op2=inventory_modules_by_alias&id=alias&return_type=csv&apipass=1234&user=admin&pass=pandora
  
Añade un módulo de plugin en la política pasada por id en el parámetro.
+
====get inventory_module_data====
 +
Obtiene los datos de un módulo de inventario utilizando nombre de agente y módulo.
 +
 
 +
Sintaxis de la llamada:
 +
*op=get (obligatorio)
 +
*op2=inventory_module_data (obligatorio)
 +
*id=<nombre de agente> (obligatorio)
 +
*id2=<nombre módulo de inventario> (opcional)
 +
*other=<parámetros serializados> (opcional), son los siguientes en este orden:
 +
**<separador>
 +
**<date_from>: <year><month><day>T<hour>:<minute>
 +
**<date_to>: <year><month><day>T<hour>:<minute>
 +
**<use_agent_alias> (opcional) acepta valores 0 y 1.
 +
 
 +
=====Ejemplos=====
 +
http://127.0.0.1/pandora_console/include/api.phpop=get&op2=inventory_module_data&id=e14ae3b959b08a1fb7a057281401a08063cf04eb714efa5fbf1cf4043cfa1314&id2=Routes&other=,|20191010T13:40|20191211T13:40|0&return_type=csv&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
 +
 
 +
====get list_collections====
 +
Devuelve la lista de todas las colecciones en Pandora FMS.
 +
 
 +
Sintaxis de la llamada:
 +
*op=get (obligatorio)
 +
*op2=list_collections (obligatorio)
 +
 
 +
=====Ejemplos=====
 +
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>
 +
 
 +
====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
 +
 
 +
=====Ejemplos=====
 +
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>
 +
 
 +
====get event_mcid====
 +
Obtiene los ID de los eventos de la metaconsola, utilizando el id del nodo y el id del evento del nodo.
 +
 
 +
{{metaconsola}}
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
*op=set (obligatorio)
 
*op2=add_plugin_module_policy (obligatorio)
 
*id=&lt;id_politica&gt; (obligatorio) debe ser un Id de política.
 
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
 
:*&lt;name_module&gt;
 
:*&lt;disabled&gt;
 
:*&lt;id_module_type&gt;
 
:*&lt;id_module_group&gt;
 
:*&lt;min_warning&gt;
 
:*&lt;max_warning&gt;
 
:*&lt;str_warning&gt;
 
:*&lt;min_critical&gt;
 
:*&lt;max_critical&gt;
 
:*&lt;str_critical&gt;
 
:*&lt;ff_threshold&gt;
 
:*&lt;history_data&gt;
 
:*&lt;module_port&gt;
 
:*&lt;snmp_community&gt;
 
:*&lt;snmp_oid&gt;
 
:*&lt;module_interval&gt;
 
:*&lt;post_process&gt;
 
:*&lt;min_value&gt;
 
:*&lt;max_value&gt;
 
:*&lt;custom_id&gt;
 
:*&lt;description&gt;
 
:*&lt;id_plugin&gt;
 
:*&lt;plugin_user&gt;
 
:*&lt;plugin_pass&gt;
 
:*&lt;plugin_parameter&gt;
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
 
:*&lt;macros&gt; (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.
 
=====Ejemplo=====
 
{
 
  "1": {
 
    "macro": "_field1_",
 
    "desc": "Target&#x20;IP",
 
    "help": "",
 
    "value": "192.168.0.1"
 
  },
 
  "2": {
 
    "macro": "_field2_",
 
    "desc": "Port",
 
    "help": "",
 
    "value": "80"
 
  }
 
}
 
:*&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;each_ff&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 
  
=====Ejemplos=====
+
*op=get (obligatorio)
 +
*op2=event_mcid (obligatorio)
 +
*id=<server_id> (obligatorio) debe ser un ID de uno de los nodos.
 +
*id2 = <id_source_event> (obligatorio) debe de ser un ID de evento del nodo.
  
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
+
=====Ejemplo=====
  
====set add_data_module_policy====
+
<nowiki>http://172.16.0.3/pandora_console/include/api.php?op=get&op2=event_mcid&return_type=json&id=0&id2=0&apipass=1234&user=admin&pass=pandora</nowiki>
  
Añade un módulo local en la política pasada por id en el parámetro.
+
===SET===
 +
Envia los datos.
 +
 
 +
====set new_agent====
 +
Crea un nuevo agente con los datos pasados como parámetros.
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=add_data_module_policy (obligatorio)
+
*op2=new_agent (obligatorio)
*id=&lt;id_política&gt; (obligatorio) debe ser un Id de politica.
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del agente, serializados en el siguiente orden:
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
+
:*&lt;alias_agente&gt;
:*&lt;name_module&gt;
+
:*&lt;ip&gt;
:*&lt;id_module_type&gt;
+
:*&lt;id_parent&gt;
 +
:*&lt;id_group&gt;
 +
:*&lt;cascade_protection&gt;
 +
:*&lt;cascade_protection_module&gt;
 +
:*&lt;interval_sec&gt;
 +
:*&lt;id_os&gt;
 +
:*&lt;name_server&gt;
 +
:*&lt;custom_id&gt;
 +
:*&lt;learning_mode&gt;
 +
:*&lt;disabled&gt;
 +
:*&lt;description&gt;
 +
:*&lt;alias_as_name&gt;
 +
 
 +
=====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>
 +
 
 +
*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====
 +
Actualiza el agente con los datos pasados como parámetros.
 +
 
 +
Sintaxis de la llamada:
 +
*op=set (obligatorio)
 +
*op2=new_agent (obligatorio)
 +
*id=&lt;id_agente&gt; (obligatorio)
 +
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del agente, serializados en el siguiente orden:
 +
:*&lt;alias_agente&gt;
 +
:*&lt;ip&gt;
 +
:*&lt;id_parent&gt;
 +
:*&lt;id_group&gt;
 +
:*&lt;cascade_protection&gt;
 +
:*&lt;cascade_protection_module&gt;
 +
:*&lt;interval_sec&gt;
 +
:*&lt;id_os&gt;
 +
:*&lt;name_server&gt;
 +
:*&lt;custom_id&gt;
 +
:*&lt;learning_mode&gt;
 +
:*&lt;disabled&gt;
 
:*&lt;description&gt;
 
:*&lt;description&gt;
:*&lt;id_module_group&gt;
 
:*&lt;min_value&gt;
 
:*&lt;max_value&gt;
 
:*&lt;post_process&gt;
 
:*&lt;module_interval&gt;
 
:*&lt;min_warning&gt;
 
:*&lt;max_warning&gt;
 
:*&lt;str_warning&gt;
 
:*&lt;min_critical&gt;
 
:*&lt;max_critical&gt;
 
:*&lt;str_critical&gt;
 
:*&lt;history_data&gt;
 
:*&lt;configuration_data&gt; Este es el bloque de definición del módulo que será insertado en el fichero de configuración del agente.
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
 
:*&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;ff_threshold&gt; (solo versión 5.1)
 
:*&lt;each_ff&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 
:*&lt;ff_timeout&gt; (solo versión 5.1)
 
  
 
=====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>
  
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
+
====set delete_agent====
 
+
Elimina un agente pasando el nombre como parámetro.
====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:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=add_snmp_module_policy (obligatorio)
+
*op2=delete_agent (obligatorio)
*id=&lt;id_política&gt; (obligatorio) debe ser un Id de política.
+
*id=&lt;nombre_agente&gt; (obligatorio) debe ser un nombre agente.
 +
*other=&lt;use_agent_alias&gt; (opcional) acepta valores 0 y 1.
 +
 
 +
=====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>
 +
 
 +
====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=&lt;id_template&gt; (obligatorio) debe ser un id de template.
 +
*other=&lt;id_modulo&gt;|&lt;id_agente&gt;
 +
 
 +
=====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>
 +
 
 +
====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=&lt;id_template&gt; (obligatorio) id de la plantilla que se aplicará sobre el agente.
 +
*id2=&lt;id_agente&gt; (obligatorio) id del agente en el que se crearán los módulos.
 +
 
 +
=====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>
 +
 
 +
====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=&lt;nombre_agente&gt; (obligatorio) debe ser un nombre agente.
 
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
 
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
 
:*&lt;name_module&gt;
 
:*&lt;name_module&gt;
Line 1,656: Line 1,728:
 
:*&lt;ff_threshold&gt;
 
:*&lt;ff_threshold&gt;
 
:*&lt;history_data&gt;
 
:*&lt;history_data&gt;
:*&lt;module_port&gt;
+
:*&lt;ip_target&gt;
:*&lt;snmp_version&gt;
+
:*&lt;tcp_port&gt;
 
:*&lt;snmp_community&gt;
 
:*&lt;snmp_community&gt;
 
:*&lt;snmp_oid&gt;
 
:*&lt;snmp_oid&gt;
Line 1,666: Line 1,738:
 
:*&lt;custom_id&gt;
 
:*&lt;custom_id&gt;
 
:*&lt;description&gt;
 
:*&lt;description&gt;
:*&lt;snmp3_priv_method [AES|DES]&gt;
 
:*&lt;snmp3_priv_pass&gt;
 
:*&lt;snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv]&gt;
 
:*&lt;snmp3_auth_method [MD5|SHA]&gt;
 
:*&lt;snmp3_auth_user&gt;
 
:*&lt;snmp3_auth_pass&gt;
 
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
:*&lt;each_ff&gt; (solo versión 5.1)
+
:*&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;each_ff&gt; (solo version 5.1)
 
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 +
:*&lt;critical_inverse&gt; (solo versión 6.0SP1)
 +
:*&lt;warning_inverse&gt; (solo versión 6.0SP1)
 +
:*&lt;ff_type&gt; (solo versión 7.34)
 +
:*&lt;use_agent_alias&gt; (Acepta valores 0 y 1)
  
 
=====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>
  
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|pepito_user|example_auth_passw&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
+
====set create_plugin_module====
 
+
Crea un módulo de tipo plugin con los datos pasados como parámetros.
====set add_agent_policy====
 
 
 
Añade un agente en una política.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=add_agent_policy (obligatorio)
+
*op2=create_plugin_module (obligatorio)
*id=&lt;id_política&gt; (obligatorio) debe ser un Id de política.
+
*id=&lt;nombre_agente&gt; (obligatorio) debe ser un nombre agente.
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del agente, serializados en el siguiente orden:
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del módulo, serializados en el siguiente orden:
:*&lt;id_agent&gt;
+
:*&lt;name_module&gt;
 
+
:*&lt;disabled&gt;
=====Ejemplos=====
+
:*&lt;id_module_type&gt;
 
 
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=add_agent_policy&id=1&other=167&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
 
 
 
====set new_network_component====
 
 
 
Crea un nuevo componente de red.
 
 
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op2=new_network_component (obligatorio)
 
*id=&lt;network_component_name&gt; (obligatorio) debe ser el nombre del componente de red.
 
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del componente de red, serializados en el siguiente orden:
 
:*&lt;network_component_type&gt;
 
:*&lt;description&gt;
 
:*&lt;module_interval&gt;
 
:*&lt;max_value&gt;
 
:*&lt;min_value&gt;
 
:*&lt;snmp_community&gt;
 
 
:*&lt;id_module_group&gt;
 
:*&lt;id_module_group&gt;
:*&lt;max_timeout&gt;
 
:*&lt;history_data&gt;
 
 
:*&lt;min_warning&gt;
 
:*&lt;min_warning&gt;
 
:*&lt;max_warning&gt;
 
:*&lt;max_warning&gt;
Line 1,722: Line 1,771:
 
:*&lt;str_critical&gt;
 
:*&lt;str_critical&gt;
 
:*&lt;ff_threshold&gt;
 
:*&lt;ff_threshold&gt;
:*&lt;post_process&gt;
+
:*&lt;history_data&gt;
:*&lt;network_component_group&gt;
+
:*&lt;ip_target&gt;
 +
:*&lt;tcp_port&gt;
 +
:*&lt;snmp_community&gt;
 +
:*&lt;snmp_oid&gt;
 +
:*&lt;module_interval&gt;
 +
:*&lt;post_process&gt;
 +
:*&lt;min_value&gt;
 +
:*&lt;max_value&gt;
 +
:*&lt;custom_id&gt;
 +
:*&lt;description&gt;
 +
:*&lt;id_plugin&gt;
 +
:*&lt;plugin_user&gt;
 +
:*&lt;plugin_pass&gt;
 +
:*&lt;plugin_parameter&gt;
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
 +
:*&lt;macros&gt; (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).
 +
:*&lt;use_agent_alias&gt; (Acepta valores 0 y 1)
 +
=====Ejemplo=====
 +
{
 +
  "1": {
 +
    "macro": "_field1_",
 +
    "desc": "Target&#x20;IP",
 +
    "help": "",
 +
    "value": "192.168.0.1",
 +
    "hide": ""
 +
  },
 +
  "2": {
 +
    "macro": "_field2_",
 +
    "desc": "Port",
 +
    "help": "",
 +
    "value": "80",
 +
    "hide": ""
 +
  }
 +
}
 +
:*&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;each_ff&gt; (solo versión 5.1)
 
:*&lt;each_ff&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 
+
:*&lt;critical_inverse&gt; (solo versión 6.0SP1)
 +
:*&lt;warning_inverse&gt; (solo versión 6.0SP1)
 +
:*&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>
  
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
+
====set create_data_module====
 +
Crea un módulo con los parámetros pasados.
  
====set new_plugin_component====
+
{{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}}
 
 
Crea un nuevo componente de plugin.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=new_plugin_component (obligatorio)
+
*op2=create_data_module (obligatorio)
*id=&lt;plugin_component_name&gt; (obligatorio) debe ser el nombre del componente de tipo plugin.
+
*id=&lt;nombre_agente&gt; (obligatorio) debe ser un nombre agente.
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del componente de tipo plugin, serializados en el siguiente orden:
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del módulo, serializados en el siguiente orden:
:*&lt;plugin_component_type&gt;
+
:*&lt;name_module&gt;
 +
:*&lt;disabled&gt;
 +
:*&lt;id_module_type&gt;
 
:*&lt;description&gt;
 
:*&lt;description&gt;
 +
:*&lt;id_module_group&gt;
 +
:*&lt;min_value&gt;
 +
:*&lt;max_value&gt;
 +
:*&lt;post_process&gt;
 
:*&lt;module_interval&gt;
 
:*&lt;module_interval&gt;
:*&lt;max_value&gt;
 
:*&lt;min_value&gt;
 
:*&lt;module_port&gt;
 
:*&lt;id_module_group&gt;
 
:*&lt;id_plugin&gt;
 
:*&lt;max_timeout&gt;
 
:*&lt;history_data&gt;
 
 
:*&lt;min_warning&gt;
 
:*&lt;min_warning&gt;
 
:*&lt;max_warning&gt;
 
:*&lt;max_warning&gt;
Line 1,760: Line 1,848:
 
:*&lt;max_critical&gt;
 
:*&lt;max_critical&gt;
 
:*&lt;str_critical&gt;
 
:*&lt;str_critical&gt;
:*&lt;ff_threshold&gt;
+
:*&lt;history_data&gt;
:*&lt;post_process&gt;
 
:*&lt;plugin_component_group&gt;
 
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
 +
:*&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;ff_threshold&gt; (solo versión 5.1)
 
:*&lt;each_ff&gt; (solo versión 5.1)
 
:*&lt;each_ff&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 +
:*&lt;ff_timeout&gt; (solo versión 5.1)
 +
:*&lt;critical_inverse&gt; (solo versión 6.0SP1)
 +
:*&lt;warning_inverse&gt; (solo versión 6.0SP1)
 +
:*&lt;ff_type&gt; (solo versión 734)
 +
:*&lt;use_agent_alias&gt; (Acepta valores 0 y 1)
  
 
=====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>
  
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
+
====set create_SNMP_module====
 
+
Crea un módulo SNMP.
====set new_snmp_component====
 
 
 
Crea un nuevo componente de SNMP.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=new_snmp_component (obligatorio)
+
*op2=create_snmp_module (obligatorio)
*id=&lt;snmp_component_name&gt; (obligatorio) debe ser el nombre del componente de tipo snmp.
+
*id=&lt;nombre_agente&gt; (obligatorio) debe ser un nombre agente.
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del componente de tipo snmp, serializados en el siguiente orden:
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del módulo, serializados en el siguiente orden:
:*&lt;snmp_component_type&gt;
+
:*&lt;name_module&gt;
:*&lt;description&gt;
+
:*&lt;disabled&gt;
:*&lt;module_interval&gt;
+
:*&lt;id_module_type&gt;
:*&lt;max_value&gt;
 
:*&lt;min_value&gt;
 
 
:*&lt;id_module_group&gt;
 
:*&lt;id_module_group&gt;
:*&lt;max_timeout&gt;
 
:*&lt;history_data&gt;
 
 
:*&lt;min_warning&gt;
 
:*&lt;min_warning&gt;
 
:*&lt;max_warning&gt;
 
:*&lt;max_warning&gt;
Line 1,797: Line 1,884:
 
:*&lt;str_critical&gt;
 
:*&lt;str_critical&gt;
 
:*&lt;ff_threshold&gt;
 
:*&lt;ff_threshold&gt;
:*&lt;post_process&gt;
+
:*&lt;history_data&gt;
 +
:*&lt;ip_target&gt;
 +
:*&lt;module_port&gt;
 
:*&lt;snmp_version&gt;
 
:*&lt;snmp_version&gt;
 +
:*&lt;snmp_community&gt;
 
:*&lt;snmp_oid&gt;
 
:*&lt;snmp_oid&gt;
:*&lt;snmp_community&gt;
+
:*&lt;module_interval&gt;
 +
:*&lt;post_process&gt;
 +
:*&lt;min_value&gt;
 +
:*&lt;max_value&gt;
 +
:*&lt;custom_id&gt;
 +
:*&lt;description&gt;
 +
:*&lt;snmp3_priv_method [AES|DES]&gt;
 +
:*&lt;snmp3_priv_pass&gt;
 +
:*&lt;snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv]&gt;
 +
:*&lt;snmp3_auth_method [MD5|SHA]&gt;
 
:*&lt;snmp3_auth_user&gt;
 
:*&lt;snmp3_auth_user&gt;
 
:*&lt;snmp3_auth_pass&gt;
 
:*&lt;snmp3_auth_pass&gt;
:*&lt;module_port&gt;
 
:*&lt;snmp3_auth_pass&gt;
 
:*&lt;snmp3_privacy_method&gt;
 
:*&lt;snmp3_privacy_pass&gt;
 
:*&lt;snmp3_auth_method&gt;
 
:*&lt;snmp3_security_level&gt;
 
:*&lt;snmp_component_group&gt;
 
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
 
:*&lt;each_ff&gt; (solo versión 5.1)
 
:*&lt;each_ff&gt; (solo versión 5.1)
Line 1,815: Line 1,907:
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 +
:*&lt;ff_type&gt; (solo versión 734)
 +
:*&lt;use_agent_alias&gt; (Acepta valores 0 y 1)
  
 
=====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)
  
  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>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</nowiki>
  
====set new_local_component====
+
Ejemplo 2 (snmp v: 1)
  
Crea un nuevo componente local.
+
<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====
 +
Actualiza la configuración de un módulo de red.
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=new_local_component (obligatorio)
+
*op2=update_network_module (obligatorio)
*id=&lt;local_component_name&gt; (obligatorio) debe ser el nombre del componente de tipo local.
+
*id=&lt;id_modulo&gt; (obligatorio) debe ser el ID numérico del módulo (tagente_modulo)
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del componente de tipo local, serializados en el siguiente orden:
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
 +
:*&lt;id_agent&gt;
 +
:*&lt;disabled&gt;
 +
:*&lt;id_module_group&gt;
 +
:*&lt;min_warning&gt;
 +
:*&lt;max_warning&gt;
 +
:*&lt;str_warning&gt;
 +
:*&lt;min_critical&gt;
 +
:*&lt;max_critical&gt;
 +
:*&lt;str_critical&gt;
 +
:*&lt;ff_threshold&gt;
 +
:*&lt;history_data&gt;
 +
:*&lt;ip_target&gt;
 +
:*&lt;tcp_port&gt;
 +
:*&lt;snmp_community&gt;
 +
:*&lt;snmp_oid&gt;
 +
:*&lt;module_interval&gt;
 +
:*&lt;post_process&gt;
 +
:*&lt;min_value&gt;
 +
:*&lt;max_value&gt;
 +
:*&lt;custom_id&gt;
 
:*&lt;description&gt;
 
:*&lt;description&gt;
:*&lt;id_os&gt;
+
:*&lt;disabled_types_event&gt; (solo versión 5)
:*&lt;local_component_group&gt;
+
:*&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;configuration_data&gt; Este es el bloque de configuración de un módulo.
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
 
:*&lt;ff_threshold&gt; (solo versión 5.1)
 
 
:*&lt;each_ff&gt; (solo versión 5.1)
 
:*&lt;each_ff&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
:*&lt;ff_timeout&gt; (solo versión 5.1)
+
:*&lt;critical_inverse&gt; (solo versión 6.0SP1)
 +
:*&lt;warning_inverse&gt; (solo versión 6.0SP1)
 +
:*&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>
  
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
+
====set update_plugin_module====
 
+
Actualiza la configuración de un módulo plugin.
====set create_alert_template====
 
 
 
Crea una plantilla de alerta.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=create_alert_template (obligatorio)
+
*op2=update_plugin_module (obligatorio)
*id=&lt;nombre_template&gt; (obligatorio) será el nombre del template creado.
+
*id=&lt;nombre_modulo&gt; (obligatorio) debe ser el ID numérico del módulo a actualizar (tagente_modulo)
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del template, serializados en el siguiente orden:
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del módulo, serializados en el siguiente orden:
:*&lt;type [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]&gt;
+
:*&lt;id_agent&gt;
 +
:*&lt;disabled&gt;
 +
:*&lt;id_module_group&gt;
 +
:*&lt;min_warning&gt;
 +
:*&lt;max_warning&gt;
 +
:*&lt;str_warning&gt;
 +
:*&lt;min_critical&gt;
 +
:*&lt;max_critical&gt;
 +
:*&lt;str_critical&gt;
 +
:*&lt;ff_threshold&gt;
 +
:*&lt;history_data&gt;
 +
:*&lt;ip_target&gt;
 +
:*&lt;tcp_port&gt;
 +
:*&lt;snmp_community&gt;
 +
:*&lt;snmp_oid&gt;
 +
:*&lt;module_interval&gt;
 +
:*&lt;post_process&gt;
 +
:*&lt;min_value&gt;
 +
:*&lt;max_value&gt;
 +
:*&lt;custom_id&gt;
 
:*&lt;description&gt;
 
:*&lt;description&gt;
:*&lt;id_alert_action&gt;
+
:*&lt;id_plugin&gt;
:*&lt;field1&gt;
+
:*&lt;plugin_user&gt;
:*&lt;field2&gt;
+
:*&lt;plugin_pass&gt;
:*&lt;field3&gt;
+
:*&lt;plugin_parameter&gt;
:*&lt;value&gt;
+
:*&lt;disabled_types_event&gt; (solo versión 5)
:*&lt;matches_value&gt;
+
:*&lt;macros&gt; (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:
:*&lt;max_value&gt;
+
** ''"macro"'': Nombre del macro. Deben ser ''_field1_'', ''_field2_'', ..., ''_fieldN_''.
:*&lt;min_value&gt;
+
**''"desc"'': Nombre descriptivo del macro.
:*&lt;time_threshold&gt;
+
**''"help"'': Descripción del macro.
:*&lt;max_alerts&gt;
+
**''"value"'': Valor del macro.
:*&lt;min_alerts&gt;
+
=====Ejemplo=====
:*&lt;time_from&gt;
+
{
:*&lt;time_to&gt;
+
  "1": {
:*&lt;monday&gt;
+
    "macro": "_field1_",
:*&lt;tuesday&gt;
+
    "desc": "Target&#x20;IP",
:*&lt;wednesday&gt;
+
    "help": "",
:*&lt;thursday&gt;
+
    "value": "192.168.0.1"
:*&lt;friday&gt;
+
  },
:*&lt;saturday&gt;
+
  "2": {
:*&lt;sunday&gt;
+
    "macro": "_field2_",
:*&lt;recovery_notify&gt;
+
    "desc": "Port",
:*&lt;field2_recovery&gt;
+
    "help": "",
:*&lt;field3_recovery&gt;
+
    "value": "80"
:*&lt;priority&gt;
+
  }
:*&lt;id_group&gt;
+
}
 +
:*&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;each_ff&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 +
:*&lt;critical_inverse&gt; (solo versión 6.0SP1)
 +
:*&lt;warning_inverse&gt; (solo versión 6.0SP1)
 +
:*&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>
  
Ejemplo 1 (condition: regexp =~ /pp/, action: Mail to XXX, max_alert: 10, min_alert: 0, priority: WARNING, group: databases):
+
====set update_data_module====
 +
<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}}
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_alert_template&id=pepito&other=regex|template%20based%20in%20regexp|1||||pp|1||||10|0|||||||||||||3&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
+
Actualiza un módulo local.
 
 
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
 
 
 
====set update_alert_template====
 
 
 
Actualiza una plantilla de alerta.
 
 
 
Sintaxis de llamada:
 
  
 +
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=update_alert_template (obligatorio)
+
*op2=update_data_module_policy (obligatorio)
*id=&lt;id_template&gt; (obligatorio) debe ser un id de template.
+
*id=&lt;id_agent_module&gt; (obligatorio) debe ser el ID numérico del módulo a actualizar.
*other=&lt;serializar parámetros&gt; (oligatorio) son los datos de configuration del template, serializados en este orden:
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del módulo, serializados en el siguiente orden:
:*&lt;template_name&gt;
+
:*&lt;id_agent&gt;
:*&lt;type [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]&gt;
+
:*&lt;disabled&gt;
:*&lt;description&gt;
+
:*&lt;id_module_group&gt;
:*&lt;id_alert_action&gt;
+
:*&lt;min_warning&gt;
:*&lt;field1&gt;
+
:*&lt;max_warning&gt;
:*&lt;field2&gt;
+
:*&lt;str_warning&gt;
:*&lt;field3&gt;
+
:*&lt;min_critical&gt;
:*&lt;value&gt;
+
:*&lt;max_critical&gt;
:*&lt;matches_value&gt;
+
:*&lt;str_critical&gt;
 +
:*&lt;ff_threshold&gt;
 +
:*&lt;history_data&gt;
 +
:*&lt;ip_target&gt;
 +
:*&lt;module_port&gt;
 +
:*&lt;snmp_community&gt;
 +
:*&lt;snmp_oid&gt;
 +
:*&lt;module_interval&gt;
 +
:*&lt;post_process&gt;
 +
:*&lt;min_value&gt;
 
:*&lt;max_value&gt;
 
:*&lt;max_value&gt;
:*&lt;min_value&gt;
+
:*&lt;custom_id&gt;
:*&lt;time_threshold&gt;
+
:*&lt;description&gt;
:*&lt;max_alerts&gt;
+
:*&lt;disabled_types_event&gt; (solo versión 5)
:*&lt;min_alerts&gt;
+
:*&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;time_from&gt;
+
:*&lt;ff_threshold&gt; (solo versión 5.1)
:*&lt;time_to&gt;
+
:*&lt;each_ff&gt; (solo versión 5.1)
:*&lt;monday&gt;
+
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
:*&lt;tuesday&gt;
+
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
:*&lt;wednesday&gt;
+
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
:*&lt;thursday&gt;
+
:*&lt;ff_timeout&gt; (solo versión 5.1)
:*&lt;friday&gt;
+
:*&lt;critical_inverse&gt; (solo versión 6.0SP1)
:*&lt;saturday&gt;
+
:*&lt;warning_inverse&gt; (solo versión 6.0SP1)
:*&lt;sunday&gt;
+
:*&lt;ff_type&gt; (solo versión 734)
:*&lt;recovery_notify&gt;
 
:*&lt;field2_recovery&gt;
 
:*&lt;field3_recovery&gt;
 
:*&lt;priority&gt;
 
:*&lt;id_group&gt;
 
  
 
=====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>
  
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
+
====set update_data_module_policy====
 +
Actualiza el módulo de datos de una política y devuelve el id del nuevo módulo.
  
====set delete_alert_template====
+
Sintaxis de la llamada:
 
+
*op=set (obligatorio)
Borra una plantilla de alerta y todas las alertas definidas por ella.
+
*op2=update_data_module (obligatorio)
 
+
*id=&lt;id_agent_module&gt; (obligatorio) debe ser el ID numérico de la política del módulo.
Sintaxis de llamada:
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del módulo, serializados en el siguiente orden:
 
+
:*&lt;id_policy_module&gt;
*op=set (oligatorio)
+
:*&lt;description&gt;
*op2=delete_alert_template (obligatorio)
+
:*&lt;id_module_group&gt;
*id=&lt;id_template&gt; (obligatorio) debe ser un id de template.
+
:*&lt;min&gt;
 +
:*&lt;max&gt;
 +
:*&lt;post_process&gt;
 +
:*&lt;module_interval&gt;
 +
:*&lt;min_warning&gt;
 +
:*&lt;max_warning&gt;
 +
:*&lt;min_critical&gt;
 +
:*&lt;max_critical&gt;
 +
:*&lt;str_critical&gt;
 +
:*&lt;history_data&gt;
 +
:*&lt;configuration_data&gt;
 +
:*&lt;disabled_types_event&gt; (solo versión 5)
 +
:*&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>
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_alert_template&id=38&apipass=1234&user=admin&pass=pandora
+
====set update_SNMP_module====
 
+
Actualiza un módulo SNMP.
====set delete_module_template====
 
 
 
Borra una plantilla de modulos.
 
 
 
Sintaxis de llamada:
 
  
 +
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=delete_module_template (obligatorio)
+
*op2=update_snmp_module (obligatorio)
*id=&lt;id_alert_template_module&gt; (obligatorio) debe ser un id de alert_template_module.
+
*id=&lt;id_module&gt; (obligatorio) debe ser un ID numérico de módulo.
 +
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
 +
:*&lt;id_agent&gt;
 +
:*&lt;disabled&gt;
 +
:*&lt;id_module_group&gt;
 +
:*&lt;min_warning&gt;
 +
:*&lt;max_warning&gt;
 +
:*&lt;str_warning&gt;
 +
:*&lt;min_critical&gt;
 +
:*&lt;max_critical&gt;
 +
:*&lt;str_critical&gt;
 +
:*&lt;ff_threshold&gt;
 +
:*&lt;history_data&gt;
 +
:*&lt;ip_target&gt;
 +
:*&lt;module_port&gt;
 +
:*&lt;snmp_version&gt;
 +
:*&lt;snmp_community&gt;
 +
:*&lt;snmp_oid&gt;
 +
:*&lt;module_interval&gt;
 +
:*&lt;post_process&gt;
 +
:*&lt;min_value&gt;
 +
:*&lt;max_value&gt;
 +
:*&lt;custom_id&gt;
 +
:*&lt;description&gt;
 +
:*&lt;snmp3_priv_method [AES|DES]&gt;
 +
:*&lt;snmp3_priv_pass&gt;
 +
:*&lt;snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv]&gt;
 +
:*&lt;snmp3_auth_method [MD5|SHA]&gt;
 +
:*&lt;snmp3_auth_user&gt;
 +
:*&lt;snmp3_auth_pass&gt;
 +
:*&lt;disabled_types_event&gt; (solo versión 5)
 +
:*&lt;each_ff&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 +
:*&lt;policy_linked&gt; (solo versión 6.1)
 +
:*&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)
  
  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>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 delete_module_template_by_names====
+
====set apply_policy====
 
+
Aplica la política, pasada por id, en uno o varios agentes.
Borra una plantilla de modulos.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=new_alert_template (obligatorio)
+
*op2=apply_policy (obligatorio)
*id=&lt;nombre del agente&gt; (obligatorio)
+
*id=&lt;id_policy&gt; (obligatorio)
*id2=&lt;nombre de la plantilla de alerta&gt; (obligatorio)
+
*id2=&lt;id_agent&gt; (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=&lt;parametros serializados&gt; (obligatorio), son los siguientes en este orden:
+
*other=&lt;parámetros serializados&gt;
:*&lt;nombre modulo&gt; (obligatorio)
+
:*&lt;name_agent (Entero)&gt; Indica si se enviará el agente por Id (0), por nombre (1) o por alias (2).
 +
:*&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>
  
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
+
====set apply_all_policies====
 
+
Aplica todas las políticas que contiene Pandora.
====set stop_downtime====
 
 
 
Para una parada planificada.
 
 
 
Sintaxis de llamada:
 
  
 +
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=stop_downtime (obligatorio)
+
*op2=apply_all_policies (obligatorio)
*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=apply_all_policies&apipass=1234&user=admin&pass=pandora</nowiki>
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=stop_downtime&id=1&apipass=1234&user=admin&pass=pandora
+
====set add_network_module_policy====
 +
Añade un módulo de red en la política pasada por id en el parámetro.
  
====Set new_user====
+
Sintaxis de la llamada:
 
 
Crea un nuevo usuario en Pandora.
 
 
 
Sintaxis de llamada:
 
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=new_user (obligatorio)
+
*op2=add_network_module_policy (obligatorio)
*id=&lt;user_name&gt; (obligatorio) será el nombre de usuario.
+
*id=&lt;id_politica&gt; (obligatorio) debe ser un Id de política
*other=&lt;parametros serializados&gt; (obligatorio) son los datos del usuario, serializados en el siguiente orden:
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
:*&lt;fullname&gt;
+
:*&lt;name_module&gt;
:*&lt;firstname&gt;
+
:*&lt;id_module_type&gt;
:*&lt;lastname&gt;
+
:*&lt;description&gt;
:*&lt;middlename&gt;
+
:*&lt;id_module_group&gt;
:*&lt;password&gt;
+
:*&lt;min_value&gt;
:*&lt;email&gt;
+
:*&lt;max_value&gt;
:*&lt;phone&gt;
+
:*&lt;post_process&gt;
:*&lt;languages&gt;
+
:*&lt;module_interval&gt;
:*&lt;comments&gt;
+
:*&lt;min_warning&gt;
 +
:*&lt;max_warning&gt;
 +
:*&lt;str_warning&gt;
 +
:*&lt;min_critical&gt;
 +
:*&lt;max_critical&gt;
 +
:*&lt;str_critical&gt;
 +
:*&lt;history_data&gt;
 +
:*&lt;ff_threshold&gt;
 +
:*&lt;disabled&gt;
 +
:*&lt;module_port&gt;
 +
:*&lt;snmp_community&gt;
 +
:*&lt;snmp_oid&gt;
 +
:*&lt;custom_id&gt;
 +
:*&lt;enable_unknown_events&gt; (solo versión 5)
 +
:*&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;each_ff&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 +
:*&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>
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_user&id=md&other=miguel|de%20dios|matias|kkk|pandora|[email protected]|666|es|descripcion%20y%20esas%20cosas&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
+
====set add_plugin_module_policy====
 +
Añade un módulo de plugin en la política pasada por id en el parámetro.
  
====Set update_user====
+
Sintaxis de la llamada:
 
+
*op=set (obligatorio)
Actualiza un usuario seleccionado por el id en parámetro id.
+
*op2=add_plugin_module_policy (obligatorio)
 
+
*id=&lt;id_politica&gt; (obligatorio) debe ser un Id de política.
Sintaxis de llamada:
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
*op=set (obligatorio)
+
:*&lt;name_module&gt;
*op2=update_user (obligatorio)
+
:*&lt;disabled&gt;
*id=&lt;user_name&gt; (oligatorio) debe ser un nombre de usuario.
+
:*&lt;id_module_type&gt;
*other=&lt;parametros serializados&gt; (obligatorio) son los datos de configuración del usuario, serializados en este orden:
+
:*&lt;id_module_group&gt;
:*&lt;fullname&gt;
+
:*&lt;min_warning&gt;
:*&lt;firstname&gt;
+
:*&lt;max_warning&gt;
:*&lt;lastname&gt;
+
:*&lt;str_warning&gt;
:*&lt;middlename&gt;
+
:*&lt;min_critical&gt;
:*&lt;password&gt;
+
:*&lt;max_critical&gt;
:*&lt;email&gt;
+
:*&lt;str_critical&gt;
:*&lt;phone&gt;
+
:*&lt;ff_threshold&gt;
:*&lt;languages&gt;
+
:*&lt;history_data&gt;
:*&lt;comments&gt;
+
:*&lt;module_port&gt;
:*&lt;is_admin&gt;
+
:*&lt;snmp_community&gt;
:*&lt;block_size&gt;
+
:*&lt;snmp_oid&gt;
:*&lt;flash_chart&gt;
+
:*&lt;module_interval&gt;
 +
:*&lt;post_process&gt;
 +
:*&lt;min_value&gt;
 +
:*&lt;max_value&gt;
 +
:*&lt;custom_id&gt;
 +
:*&lt;description&gt;
 +
:*&lt;id_plugin&gt;
 +
:*&lt;plugin_user&gt;
 +
:*&lt;plugin_pass&gt;
 +
:*&lt;plugin_parameter&gt;
 +
:*&lt;enable_unknown_events&gt; (solo versión 5)
 +
:*&lt;macros&gt; (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.
 +
=====Ejemplo=====
 +
{
 +
  "1": {
 +
    "macro": "_field1_",
 +
    "desc": "Target&#x20;IP",
 +
    "help": "",
 +
    "value": "192.168.0.1"
 +
  },
 +
  "2": {
 +
    "macro": "_field2_",
 +
    "desc": "Port",
 +
    "help": "",
 +
    "value": "80"
 +
  }
 +
}
 +
:*&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;each_ff&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 +
:*&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>
  
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
+
====set add_data_module_policy====
 
+
Añade un módulo local en la política pasada por id en el parámetro.
====set delete_user====
 
 
 
Borra un usuario seleccionado.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=delete_user (obligatorio)
+
*op2=add_data_module_policy (obligatorio)
*id=&lt;nombre_usuario&gt; (obligatorio) debe ser un nombre usuario.
+
*id=&lt;id_política&gt; (obligatorio) debe ser un Id de política.
 +
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del módulo, serializados en el siguiente orden:
 +
:*&lt;name_module&gt;
 +
:*&lt;id_module_type&gt;
 +
:*&lt;description&gt;
 +
:*&lt;id_module_group&gt;
 +
:*&lt;min_value&gt;
 +
:*&lt;max_value&gt;
 +
:*&lt;post_process&gt;
 +
:*&lt;module_interval&gt;
 +
:*&lt;min_warning&gt;
 +
:*&lt;max_warning&gt;
 +
:*&lt;str_warning&gt;
 +
:*&lt;min_critical&gt;
 +
:*&lt;max_critical&gt;
 +
:*&lt;str_critical&gt;
 +
:*&lt;history_data&gt;
 +
:*&lt;configuration_data&gt; Este es el bloque de definición del módulo que será insertado en el fichero de configuración del agente.
 +
:*&lt;enable_unknown_events&gt; (solo versión 5)
 +
:*&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;ff_threshold&gt; (solo versión 5.1)
 +
:*&lt;each_ff&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 +
:*&lt;ff_timeout&gt; (solo versión 5.1)
 +
:*&lt;ff_type&gt; (solo versión 734)
  
 
=====Ejemplos=====
 
=====Ejemplos=====
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_user&id=md&apipass=1234&user=admin&pass=pandora
+
  <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 enable_disable_user====
+
====set add_SNMP_module_policy====
 
+
Añade un módulo SNMP en la política pasada por id en el parámetro.
Activa un usuario desactivado.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=enable_disable_user (obligatorio)
+
*op2=add_snmp_module_policy (obligatorio)
*id=&lt;nombre_usuario&gt; (obligatorio) debe ser un nombre usuario.
+
*id=&lt;id_política&gt; (obligatorio) debe ser un Id de política.
 
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del modulo, serializados en el siguiente orden:
 +
:*&lt;name_module&gt;
 +
:*&lt;disabled&gt;
 +
:*&lt;id_module_type&gt;
 +
:*&lt;id_module_group&gt;
 +
:*&lt;min_warning&gt;
 +
:*&lt;max_warning&gt;
 +
:*&lt;str_warning&gt;
 +
:*&lt;min_critical&gt;
 +
:*&lt;max_critical&gt;
 +
:*&lt;str_critical&gt;
 +
:*&lt;ff_threshold&gt;
 +
:*&lt;history_data&gt;
 +
:*&lt;module_port&gt;
 +
:*&lt;snmp_version&gt;
 +
:*&lt;snmp_community&gt;
 +
:*&lt;snmp_oid&gt;
 +
:*&lt;module_interval&gt;
 +
:*&lt;post_process&gt;
 +
:*&lt;min_value&gt;
 +
:*&lt;max_value&gt;
 +
:*&lt;custom_id&gt;
 +
:*&lt;description&gt;
 +
:*&lt;snmp3_priv_method [AES|DES]&gt;
 +
:*&lt;snmp3_priv_pass&gt;
 +
:*&lt;snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv]&gt;
 +
:*&lt;snmp3_auth_method [MD5|SHA]&gt;
 +
:*&lt;snmp3_auth_user&gt;
 +
:*&lt;snmp3_auth_pass&gt;
 +
:*&lt;enable_unknown_events&gt; (solo versión 5)
 +
:*&lt;each_ff&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 +
:*&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>
  
Ejemplo 1 (Disable user 'example_name')
+
====set add_agent_policy_by_id====
 +
Añade un agente en una política utilizando el ID de agente.
  
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
+
Sintaxis de la llamada:
 
+
*op=set (obligatorio)
Ejemplo 2 (Enable user 'example_name')
+
*op2=add_agent_policy_by_id (obligatorio)
 
+
*id=&lt;id_política&gt; (obligatorio) debe ser un Id de política.
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
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del agente, serializados en el siguiente orden:
 +
:*&lt;id_agent&gt;
 +
:*&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.
  
====set create_group====
+
=====Ejemplos=====
 +
* 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>
  
Crea un nuevo grupo.
+
* Metaconsola:
 +
<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>
  
Call syntax:
+
====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)
 
*op=set (obligatorio)
*op2=create_group (obligatorio)
+
*op2=add_agent_policy_by_name (obligatorio)
*id=&lt;group_name&gt; (obligatorio) debe ser un nombre de grupo.
+
*id=&lt;id_política&gt; (obligatorio) debe ser un Id de política.
*other=&lt;serialized_parameters&gt; (obligatorio), son los siguientes en este orden:
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del agente, serializados en el siguiente orden:
:*&lt;icon name&gt;
+
:*&lt;agent_name&gt;
:*&lt;parent group id&gt; (opcional)
 
:*&lt;description&gt; (opcional)
 
:*&lt;propagate acl&gt; (opcional)
 
:*&lt;desactivar las alertas&gt; (opcional)
 
:*&lt;custom id&gt; (opcional)
 
:*&lt;Informacion de contacto&gt; (opcional)
 
:*&lt;otra informacion&gt; (opcional)
 
  
 
=====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>
  
Ejemplo 1 (con grupo padre: Servers)
+
====set remove_agent_from_policy_by_id====
+
Elimina un agente de una política utilizando el ID de agente.
  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
+
 
+
Sintaxis de la llamada:
Ejemplo 2 (sin grupo padre)
+
*op=set (obligatorio)
+
*op2=remove_agent_from_policy_by_id (obligatorio)
  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
+
*id=&lt;id_política&gt; (obligatorio) debe ser un Id de política.
 +
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del agente, serializados en el siguiente orden:
 +
:*&lt;id_agent&gt;
 +
:*&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.
  
====set update_group====
+
=====Ejemplos=====
 +
* 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>
  
Actualiza el grupo con los datos pasados como parametros.
+
* Metaconsola:
 +
<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>
  
Call syntax:
+
====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)
 
*op=set (obligatorio)
*op2=update_group (obligatorio)
+
*op2=remove_agent_from_policy_by_name (obligatorio)
*id=&lt;group_id&gt; (obligatorio) id_grupo.
+
*id=&lt;id_política&gt; (obligatorio) debe ser un Id de política.
*other=&lt;serialized_parameters&gt; (obligatorio), son los siguientes en este orden:
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del agente, serializados en el siguiente orden:
:*&lt;group name&gt;
+
:*&lt;agent_name&gt;
:*&lt;icon name&gt;
 
:*&lt;parent group id&gt;
 
:*&lt;description&gt;
 
:*&lt;propagate acl&gt;
 
:*&lt;desactivar las alertas&gt;
 
:*&lt;custom id&gt;
 
:*&lt;Informacion de contacto&gt;
 
:*&lt;otra informacion&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>
  
  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
+
====set new_network_component====
 
+
Crea un nuevo componente de red.
====set add_user_profile====
 
 
 
Añade un perfil a un usuario.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=add_user_profile (obligatorio)
+
*op2=new_network_component (obligatorio)
*id=&lt;nombre_usuario&gt; (obligatorio) debe ser un nombre usuario.
+
*id=&lt;network_component_name&gt; (obligatorio) debe ser el nombre del componente de red.
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del grupo y profile, serializados en el siguiente orden:
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del componente de red, serializados en el siguiente orden:
:*&lt;grupo&gt;
+
:*&lt;network_component_type&gt;
:*&lt;profile&gt;
+
:*&lt;description&gt;
 
+
:*&lt;module_interval&gt;
=====Ejemplos=====
+
:*&lt;max_value&gt;
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
+
:*&lt;min_value&gt;
 
+
:*&lt;snmp_community&gt;
====set delete_user_profile====
+
:*&lt;id_module_group&gt;
 
+
:*&lt;max_timeout&gt;
Quita un perfil a un usuario.
+
:*&lt;history_data&gt;
 +
:*&lt;min_warning&gt;
 +
:*&lt;max_warning&gt;
 +
:*&lt;str_warning&gt;
 +
:*&lt;min_critical&gt;
 +
:*&lt;max_critical&gt;
 +
:*&lt;str_critical&gt;
 +
:*&lt;ff_threshold&gt;
 +
:*&lt;post_process&gt;
 +
:*&lt;network_component_group&gt;
 +
:*&lt;enable_unknown_events&gt; (solo versión 5)
 +
:*&lt;each_ff&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 +
:*&lt;ff_type&gt; (solo versión 734)
  
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op2=delete_user_profile (obligatorio)
 
*id=&lt;nombre_usuario&gt; (obligatorio) debe ser un nombre usuario.
 
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del grupo y profile, serializados en el siguiente orden:
 
:*&lt;grupo&gt;
 
:*&lt;profile&gt;
 
  
 
=====Ejemplos=====
 
=====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
+
  <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_incident====
+
====set new_plugin_component====
 
+
Crea un nuevo componente de plugin.
Crea un nuevo incidente.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=new_incident (obligatorio)
+
*op2=new_plugin_component (obligatorio)
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del incidente, serializados en el siguiente orden:
+
*id=&lt;plugin_component_name&gt; (obligatorio) debe ser el nombre del componente de tipo plugin.
:*&lt;titulo&gt;
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del componente de tipo plugin, serializados en el siguiente orden:
:*&lt;descripción&gt;
+
:*&lt;plugin_component_type&gt;
:*&lt;origen&gt;
+
:*&lt;description&gt;
:*&lt;prioridad&gt;
+
:*&lt;module_interval&gt;
:*&lt;estado&gt;
+
:*&lt;max_value&gt;
:*&lt;grupo&gt;
+
:*&lt;min_value&gt;
 +
:*&lt;module_port&gt;
 +
:*&lt;id_module_group&gt;
 +
:*&lt;id_plugin&gt;
 +
:*&lt;max_timeout&gt;
 +
:*&lt;history_data&gt;
 +
:*&lt;min_warning&gt;
 +
:*&lt;max_warning&gt;
 +
:*&lt;str_warning&gt;
 +
:*&lt;min_critical&gt;
 +
:*&lt;max_critical&gt;
 +
:*&lt;str_critical&gt;
 +
:*&lt;ff_threshold&gt;
 +
:*&lt;post_process&gt;
 +
:*&lt;plugin_component_group&gt;
 +
:*&lt;enable_unknown_events&gt; (solo versión 5)
 +
:*&lt;each_ff&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 +
:*&lt;ff_type&gt; (solo versión 734)
  
 
=====Ejemplos=====
 
=====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
+
  <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_note_incident====
+
====set new_snmp_component====
 
+
Crea un nuevo componente de SNMP.
Crea una nota dentro de una incidencia.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=new_note_incident (obligatorio)
+
*op2=new_snmp_component (obligatorio)
*id=&lt;id_incidente&gt; (obligatorio) el id del incidente.
+
*id=&lt;snmp_component_name&gt; (obligatorio) debe ser el nombre del componente de tipo snmp.
*id2=&lt;nombre_usuario&gt; (obligatorio) el nombre del usuario.
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del componente de tipo snmp, serializados en el siguiente orden:
*other=&lt;nota&gt; (obligatorio) es la nota codificada en url encode.
+
:*&lt;snmp_component_type&gt;
 
+
:*&lt;description&gt;
 +
:*&lt;module_interval&gt;
 +
:*&lt;max_value&gt;
 +
:*&lt;min_value&gt;
 +
:*&lt;id_module_group&gt;
 +
:*&lt;max_timeout&gt;
 +
:*&lt;history_data&gt;
 +
:*&lt;min_warning&gt;
 +
:*&lt;max_warning&gt;
 +
:*&lt;str_warning&gt;
 +
:*&lt;min_critical&gt;
 +
:*&lt;max_critical&gt;
 +
:*&lt;str_critical&gt;
 +
:*&lt;ff_threshold&gt;
 +
:*&lt;post_process&gt;
 +
:*&lt;snmp_version&gt;
 +
:*&lt;snmp_oid&gt;
 +
:*&lt;snmp_community&gt;
 +
:*&lt;snmp3_auth_user&gt;
 +
:*&lt;snmp3_auth_pass&gt;
 +
:*&lt;module_port&gt;
 +
:*&lt;snmp3_privacy_method&gt;
 +
:*&lt;snmp3_privacy_pass&gt;
 +
:*&lt;snmp3_auth_method&gt;
 +
:*&lt;snmp3_security_level&gt;
 +
:*&lt;snmp_component_group&gt;
 +
:*&lt;enable_unknown_events&gt; (solo versión 5)
 +
:*&lt;each_ff&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 +
:*&lt;ff_type&gt; (solo versión 734)
 +
 
 +
 
 
=====Ejemplos=====
 
=====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
+
  <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 validate_all_alerts====
+
====set new_local_component====
 
+
Crea un nuevo componente local.
Valida todas las alertas.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=validate_all_alerts (obligatorio)
+
*op2=new_local_component (obligatorio)
 +
*id=&lt;local_component_name&gt; (obligatorio) debe ser el nombre del componente de tipo local.
 +
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del componente de tipo local, serializados en el siguiente orden:
 +
:*&lt;description&gt;
 +
:*&lt;id_os&gt;
 +
:*&lt;local_component_group&gt;
 +
:*&lt;configuration_data&gt; Este es el bloque de configuración de un módulo.
 +
:*&lt;enable_unknown_events&gt; (solo versión 5)
 +
:*&lt;ff_threshold&gt; (solo versión 5.1)
 +
:*&lt;each_ff&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_normal&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_warning&gt; (solo versión 5.1)
 +
:*&lt;ff_threshold_critical&gt; (solo versión 5.1)
 +
:*&lt;ff_timeout&gt; (solo versión 5.1)
 +
:*&lt;ff_type&gt; (solo versión 734)
  
 
=====Ejemplos=====
 
=====Ejemplos=====
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_alerts&apipass=1234&user=admin&pass=pandora
+
  <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 validate_all_policy_alerts====
+
====set create_alert_template====
 
+
Crea una plantilla de alerta.
Valida todas las alertas que vienen de políticas.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
*op=set (obligatorio)
 
*op2=validate_all_policy_alerts (obligatorio)
 
  
=====Ejemplos=====
 
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=validate_all_policy_alerts&apipass=1234&user=admin&pass=pandora
 
 
====set event_validate_filter====
 
 
Valida todos los eventos que pasan el filtro pasado como parámetros.
 
 
{{metaconsola}}
 
 
Sintaxis de la llamada:
 
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=event_validate_filter (obligatorio)
+
*op2=create_alert_template (obligatorio)
*other_mode=url_encode_separator_| (opcional)
+
*id=&lt;template_name&gt; (obligatorio) el nombre de la plantilla.
*other=&lt;parámetros serializados&gt; (opcional), son los siguientes en este orden:
+
*other=&lt;serialized parameters&gt; (obligatorio) las configuraciones y datos de la plantilla, serializados en el siguiente orden:
:*&lt;separator&gt;
+
:*&lt;type [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]&gt;
:*&lt;criticity&gt; De 0 a 4
+
:*&lt;description&gt;
:*&lt;nombre agente&gt;
+
:*&lt;id_alert_action&gt;
:*&lt;nombre módulo&gt;
+
:*&lt;field1&gt;
:*&lt;nombre plantilla de alerta&gt;
+
:*&lt;field2&gt;
:*&lt;usuario&gt;
+
:*&lt;field3&gt;
:*&lt;nivel mínimo intervalo numérico &gt; en unix timestamp
+
:*&lt;value&gt;
:*&lt;nivel máximo intervalo numérico &gt; en unix timestamp
+
:*&lt;matches_value&gt;
 +
:*&lt;max_value&gt;
 +
:*&lt;min_value&gt;
 +
:*&lt;time_threshold&gt;
 +
:*&lt;max_alerts&gt;
 +
:*&lt;min_alerts&gt;
 +
:*&lt;time_from&gt;
 +
:*&lt;time_to&gt;
 +
:*&lt;monday&gt;
 +
:*&lt;tuesday&gt;
 +
:*&lt;wednesday&gt;
 +
:*&lt;thursday&gt;
 +
:*&lt;friday&gt;
 +
:*&lt;saturday&gt;
 +
:*&lt;sunday&gt;
 +
:*&lt;recovery_notify&gt;
 +
:*&lt;field2_recovery&gt;
 +
:*&lt;field3_recovery&gt;
 +
:*&lt;priority&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):
  
  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>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</nowiki>
  
====set event_validate_filter_pro====
+
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):
 +
 
 +
<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>
  
Es igual que la anterior.
+
====set update_alert_template====
 +
Actualiza una plantilla de alerta.
  
{{metaconsola}}
+
Sintaxis de llamada:
  
Sintaxis de la llamada:
 
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=event_validate_filter_pro (obligatorio)
+
*op2=update_alert_template (obligatorio)
*other_mode=url_encode_separator_| (opcional)
+
*id=&lt;id_template&gt; (obligatorio) debe ser un id de template.
*other=&lt;parámetros serializados&gt; (opcional), son los siguientes en este orden:
+
*other=&lt;serializar parámetros&gt; (oligatorio) son los datos de configuration del template, serializados en este orden:
:*&lt;separator&gt;
+
:*&lt;template_name&gt;
:*&lt;criticity&gt; De 0 a 4
+
:*&lt;type [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always]&gt;
:*&lt;id agente&gt;
+
:*&lt;description&gt;
:*&lt;id modulo&gt;
+
:*&lt;id_alert_action&gt;
:*&lt;id agente modulo alerta&gt;
+
:*&lt;field1&gt;
:*&lt;usuario&gt;
+
:*&lt;field2&gt;
:*&lt;nivel mínimo intervalo numérico &gt; en unix timestamp
+
:*&lt;field3&gt;
:*&lt;nivel máximo intervalo numérico &gt; en unix timestamp
+
:*&lt;value&gt;
 
+
:*&lt;matches_value&gt;
=====Ejemplos=====
+
:*&lt;max_value&gt;
 
+
:*&lt;min_value&gt;
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
+
:*&lt;time_threshold&gt;
 
+
:*&lt;max_alerts&gt;
====set new_alert_template====
+
:*&lt;min_alerts&gt;
Aplica una alerta desde una plantilla y un módulo pasado como id de agente y nombre de módulo.
+
:*&lt;time_from&gt;
 
+
:*&lt;time_to&gt;
 
+
:*&lt;monday&gt;
Sintaxis de la llamada:
+
:*&lt;tuesday&gt;
*op=set (obligatorio)
+
:*&lt;wednesday&gt;
*op2=new_alert_template (obligatorio)
+
:*&lt;thursday&gt;
*id=&lt;nombre del agente&gt; (obligatorio)
+
:*&lt;friday&gt;
*id2=&lt;nombre de la plantilla de alerta&gt; (obligatorio)
+
:*&lt;saturday&gt;
*other_mode=url_encode_separator_| (opcional)
+
:*&lt;sunday&gt;
*other=&lt;parámetros serializados&gt; (obligatorio), son los siguientes en este orden:
+
:*&lt;recovery_notify&gt;
:*&lt;nombre modulo&gt; (obligatorio)
+
:*&lt;field2_recovery&gt;
 +
:*&lt;field3_recovery&gt;
 +
:*&lt;priority&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>
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_alert_template&id=miguel-portatil&id2=test&other_mode=url_encode_separator_|&other=memfree&apipass=1234&user=admin&pass=pandora
+
====set delete_alert_template====
 +
Borra una plantilla de alerta y todas las alertas definidas por ella.
  
====set alert_actions====
+
Sintaxis de llamada:
  
Añade acciones a una alerta.
+
*op=set (oligatorio)
 
+
*op2=delete_alert_template (obligatorio)
Sintaxis de la llamada:
+
*id=&lt;id_template&gt; (obligatorio) debe ser un id de template.
*op=set (obligatorio)
 
*op2=alert_actions (obligatorio)
 
*id=&lt;nombre del agente&gt; (obligatorio)
 
*id2=&lt;nombre de la plantilla de alerta&gt; (obligatorio)
 
*other_mode=url_encode_separator_| (opcional)
 
*other=&lt;parámetros serializados&gt; (obligatorio), son los siguientes en este orden:
 
:*&lt;nombre modulo&gt; (obligatorio)
 
:*&lt;nombre acción&gt; (obligatorio)
 
:*&lt;fires min &gt; (opcional)
 
:*&lt;fires max &gt; (opcional)
 
  
 
=====Ejemplos=====
 
=====Ejemplos=====
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=alert_actions&id=miguel-portatil&id2=test&other_mode=url_encode_separator_|&other=memfree|test&apipass=1234&user=admin&pass=pandora
+
  <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>
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=alert_actions&id=miguel-portatil&id2=test&other_mode=url_encode_separator_|&other=memfree|test|1|3&apipass=1234&user=admin&pass=pandora
+
====set delete_module_template====
 +
Borra una plantilla de módulos.
  
====set new_module====
+
Sintaxis de llamada:
Crea un nuevo módulo.
 
  
Sintaxis de la llamada:
 
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=new_module (obligatorio)
+
*op2=delete_module_template (obligatorio)
*id=&lt;nombre del agente&gt; (obligatorio)
+
*id=&lt;id_alert_template_module&gt; (obligatorio) debe ser un id de alert_template_module.
*id2=&lt;nombre del nuevo modulo&gt; (obligatorio)
 
*other_mode=url_encode_separator_| (opcional)
 
*other=&lt;parámetros serializados&gt; (obligatorio), son los siguientes en este orden:
 
:*&lt;tipo de modulo de red&gt; (obligatorio)
 
:*&lt;nombre acción&gt; (obligatorio)
 
:*&lt;ip o url &gt; (obligatorio)
 
:*&lt;puerto &gt; (opcional)
 
:*&lt;descripción &gt; (opcional)
 
:*&lt;min &gt; (opcional)
 
:*&lt;max &gt; (opcional)
 
:*&lt;post process &gt; (opcional)
 
:*&lt;module interval &gt; (opcional)
 
:*&lt;min warning &gt; (opcional)
 
:*&lt;max warning &gt; (opcional)
 
:*&lt;min critical &gt; (opcional)
 
:*&lt;max critical &gt; (opcional)
 
:*&lt;history data &gt; (opcional)
 
:*&lt;enable_unknown_events&gt; (solo versión 5)
 
  
 
=====Ejemplos=====
 
=====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
+
  <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====
+
====set delete_module_template_by_names====
Borra un módulo.
+
Borra una plantilla de módulos.
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 +
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=delete_module (obligatorio)
+
*op2=new_alert_template (obligatorio)
 
*id=&lt;nombre del agente&gt; (obligatorio)
 
*id=&lt;nombre del agente&gt; (obligatorio)
*id2=&lt;nombre del modulo&gt; (obligatorio)
+
*id2=&lt;nombre de la plantilla de alerta&gt; (obligatorio)
*other=simulate (opcional)
+
*other=&lt;parametros serializados&gt; (obligatorio), son los siguientes en este orden:
 +
:*&lt;nombre modulo&gt; (obligatorio)
 +
:*&lt;use_agent_alias&gt; (Acepta valores 0 y 1)
  
 
=====Ejemplos=====
 
=====Ejemplos=====
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module&id=miguel-portatil&id2=juanito&other=simulate&apipass=1234&user=admin&pass=pandora
+
  <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&other_mode=url_encode_separator_|</nowiki>
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_module&id=miguel-portatil&id2=juanito&apipass=1234&user=admin&pass=pandora
+
====set stop_downtime====
 +
Para una parada planificada.
  
====set enable_alert====
+
Sintaxis de llamada:
Activa una alerta dentro de un agente.
 
 
 
Sintaxis de la llamada:
 
  
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=enable_alert
+
*op2=stop_downtime (obligatorio)
*id=&lt;Nombre del agente&gt; (obligatorio)
+
*id=&lt;id_downtime&gt; (obligatorio) debe ser un id downtime.
*id2=&lt;Nombre del modulo&gt; (obligatorio)
 
*other: nombre del template de la alerta (p.e: Warning event) (obligatorio)
 
  
 +
=====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>
  
===== Ejemplo =====
+
====Set new_user====
 +
Crea un nuevo usuario en Pandora FMS.
  
http://localhost/pandora_console/include/api.php?op=set&op2=enable_alert&id=garfio&id2=Status&other=Warning%20condition&apipass=1234&user=admin&pass=pandora
+
Sintaxis de llamada:
 +
*op=set (obligatorio)
 +
*op2=new_user (obligatorio)
 +
*id=&lt;user_name&gt; (obligatorio) será el nombre de usuario.
 +
*other=&lt;parametros serializados&gt; (obligatorio) son los datos del usuario, serializados en el siguiente orden:
 +
:*&lt;fullname&gt;
 +
:*&lt;firstname&gt;
 +
:*&lt;lastname&gt;
 +
:*&lt;middlename&gt;
 +
:*&lt;password&gt;
 +
:*&lt;email&gt;
 +
:*&lt;phone&gt;
 +
:*&lt;languages&gt;
 +
:*&lt;comments&gt;
 +
:*&lt;time_autorefresh&gt;
 +
:*&lt;default_event_filter&gt;
 +
:*&lt;section&gt;
 +
:*&lt;session_time&gt; (-1 para establecer la sesión como permanente)
  
====set disable_alert====
 
  
Desactiva una alerta dentro de un agente.
+
=====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>
  
Sintaxis de la llamada:
+
====Set update_user====
 +
Actualiza un usuario seleccionado por el id en parámetro id.
  
 +
Sintaxis de llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=disable_alert
+
*op2=update_user (obligatorio)
*id=&lt;Nombre del agente&gt; (obligatorio)
+
*id=&lt;user_name&gt; (oligatorio) debe ser un nombre de usuario.
*id2=&lt;Nombre del modulo&gt; (obligatorio)
+
*other=&lt;parametros serializados&gt; (obligatorio) son los datos de configuración del usuario, serializados en este orden:
*other: nombre del template de la alerta (p.e: Warning event) (obligatorio)
+
:*&lt;fullname&gt;
 +
:*&lt;firstname&gt;
 +
:*&lt;lastname&gt;
 +
:*&lt;middlename&gt;
 +
:*&lt;password&gt;
 +
:*&lt;email&gt;
 +
:*&lt;phone&gt;
 +
:*&lt;languages&gt;
 +
:*&lt;comments&gt;
 +
:*&lt;is_admin&gt;
 +
:*&lt;block_size&gt;
 +
:*&lt;flash_chart&gt;
  
 +
=====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>
  
===== Ejemplo =====
+
====set delete_user====
 +
Borra un usuario seleccionado.
  
http://localhost/pandora_console/include/api.php?op=set&op2=disable_alert&id=garfio&id2=Status&other=Warning%20condition&apipass=1234&user=admin&pass=pandora
+
Sintaxis de la llamada:
 +
*op=set (obligatorio)
 +
*op2=delete_user (obligatorio)
 +
*id=&lt;nombre_usuario&gt; (obligatorio) debe ser un nombre usuario.
  
====set enable_module_alerts====
+
=====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>
  
Igual que la llamada enable_alert.
+
====Set delete_user_permissions====
 +
<br>
 +
{{metaconsola}}
 +
Borra premisos de usuario.
  
Sintaxis de la llamada:
+
Call syntax:
  
*op=set (obligatorio)
+
*Op = set(obligatorio)
*op2=enable_module_alerts
+
*Op2 =delete_user_permission(obligatorio)
*id=&lt;Nombre del agente&gt; (obligatorio)
+
*Return_type = csv|json(obligatorio)
*id2=&lt;Nombre del modulo&gt; (obligatorio)
+
*Other = id profile(obligatorio)
  
 +
=====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>
  
===== Ejemplo =====
 
  
http://localhost/pandora_console/include/api.php?op=set&op2=enable_module_alerts&id=garfio&id2=Status&apipass=1234&user=admin&pass=pandora
+
Borra los permisos de un usuario
 +
Puede retornar Json o CSV, este retorno se indica mediante la URL.
  
====set disable_module_alerts====
+
====Set add_permission_user_group====
 +
<br>
 +
{{metaconsola}}
  
Igual que la llamada disable_alert.
+
Añadir permisos a un grupo de usuario.
  
Sintaxis de la llamada:
+
Call syntax:
 
+
* Op = set(obligatorio)
*op=set (obligatorio)
+
* Op2 =add_permission_user_to_group(obligatorio)
*op2=disable_module_alerts
+
* Return_type = csv|json(obligatorio)
*id=&lt;Nombre del agente&gt; (obligatorio)
+
* Other = user id(obligatorio)|group_id(obligatorio)|profile id(obligatorio)|No hierarchy(opcional)| permissions id(opcional)
*id2=&lt;Nombre del modulo&gt; (obligatorio)
 
  
 +
=====Ejemplo=====
 +
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.}}
  
===== Ejemplo =====
+
{{Warning|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=disable_module_alerts&id=garfio&id2=Status&apipass=1234&user=admin&pass=pandora
+
  <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_module====
+
====set enable_disable_user====
 
+
Activa un usuario desactivado.
Activa el módulo.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=enable_module
+
*op2=enable_disable_user (obligatorio)
*id=&lt;Nombre del agente&gt; (obligatorio)
+
*id=&lt;nombre_usuario&gt; (obligatorio) debe ser un nombre usuario.
*id2=&lt;Nombre del modulo&gt; (obligatorio)
 
  
 +
=====Ejemplos=====
 +
Ejemplo 1 (Disable user 'example_name')
  
===== Ejemplo =====
+
<nowiki>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</nowiki>
  
  http://localhost/pandora_console/include/api.php?op=set&op2=enable_module&id=garfio&id2=Status&apipass=1234&user=admin&pass=pandora
+
Ejemplo 2 (Enable user 'example_name')
 +
 
 +
  <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 disable_module====
+
====set meta_synch_user====
 +
{{metaconsola}}
 +
Sincroniza usuarios de la metaconsola con el nodo
  
Desactiva el módulo.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=disable_module
+
*op2=meta_synch_user (obligatorio)
*id=&lt;Nombre del agente&gt; (obligatorio)
+
*other=&lt;parámetros serializados&gt; (opcional):
*id2=&lt;Nombre del modulo&gt; (obligatorio)
+
:*&lt;user_name_1,user_name_2,user_name_3..&gt; (Nombres de los usuarios separados por comas y sin espacios al inicio o al final, obligatorio)
 +
:*&lt;server_name&gt; (obligatorio)
 +
:*&lt;profile_mode(1-0)&gt; (opcional)
 +
:*&lt;group_name&gt; (opcional)
 +
:*&lt;profile_1,profile_2,profile_3&gt; (Perfiles separados por comas y sin espacios al principio y al final, opcional)
 +
:*&lt;create_groups(1-0)&gt; (opcional)
  
 +
=====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>
  
===== Ejemplo =====
+
====set create_group====
 +
Crea un nuevo grupo.
  
http://localhost/pandora_console/include/api.php?op=set&op2=disable_module&id=garfio&id2=Status&apipass=1234&user=admin&pass=pandora
+
Call syntax:
 
 
====set create_network_module_from_component====
 
 
 
Crea un nuevo módulo de red desde un componente.
 
 
 
Sintaxis de la llamada:
 
  
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=create_network_module_from_component (obligatorio)
+
*op2=create_group (obligatorio)
*id=&lt;Nombre del agente&gt; (obligatorio)
+
*id=&lt;group_name&gt; (obligatorio) debe ser un nombre de grupo.
*id2=&lt;Nombre del componente&gt; (obligatorio)
+
*other=&lt;serialized_parameters&gt; (obligatorio), son los siguientes en este orden:
 +
:*&lt;icon name&gt;
 +
:*&lt;parent group id&gt; (opcional)
 +
:*&lt;description&gt; (opcional)
 +
:*&lt;propagate acl&gt; (opcional)
 +
:*&lt;desactivar las alertas&gt; (opcional)
 +
:*&lt;custom id&gt; (opcional)
 +
:*&lt;Informacion de contacto&gt; (opcional)
 +
:*&lt;otra informacion&gt; (opcional)
  
 +
=====Ejemplos=====
 +
Ejemplo 1 (con grupo padre: Servers)
 +
 +
  <nowiki>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</nowiki>
 +
 +
Ejemplo 2 (sin grupo padre)
 +
 +
  <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>
  
===== Ejemplo =====
+
====set update_group====
 +
Actualiza el grupo con los datos pasados como parámetros.
  
http://localhost/pandora_console/include/api.php?op=set&op2=create_network_module_from_component&id=garfio&id2=OS Total process&apipass=1234&user=admin&pass=pandora
+
Call syntax:
  
====set module_data====
 
 
Añade un nuevo valor al módulo.
 
 
Sintaxis de la llamada:
 
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=module_data (obligatorio)
+
*op2=update_group (obligatorio)
*id=&lt;id agente módulo&gt; (obligatorio)
+
*id=&lt;group_id&gt; (obligatorio) id_grupo.
*other: serializado el dato del módulo y el tiempo en que ocurre.
+
*other=&lt;serialized_parameters&gt; (obligatorio), son los siguientes en este orden:
**dato: que puede ser cualquier tipo de dato de Pandora.
+
:*&lt;group name&gt;
**tiempo: puede ser la cadena de texto "now" para el momento actual o el timestamp especifico.
+
:*&lt;icon name&gt;
 +
:*&lt;parent group id&gt;
 +
:*&lt;description&gt;
 +
:*&lt;propagate acl&gt;
 +
:*&lt;desactivar las alertas&gt;
 +
:*&lt;custom id&gt;
 +
:*&lt;Informacion de contacto&gt;
 +
:*&lt;otra informacion&gt;
  
 
=====Ejemplos=====
 
=====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
+
  <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 add_module_in_conf====
+
====set delete_group====
>= 5.0 (Sólo Enterprise)
+
Eliminar un grupo
  
Añade una configuración a un módulo local.
+
Call syntax:
 
 
Sintaxis de la llamada:
 
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=add_module_in_conf (obligatorio)
+
*op2=update_group (obligatorio)
*id=&lt;id agente&gt; (obligatorio)
+
*id=&lt;group_id&gt; (obligatorio) id_grupo.
*id2=&lt;nombre módulo&gt; (obligatorio)
 
*other: los datos del modulo que irán en el fichero de configuración codificados en base64 (obligatorio)
 
  
 
=====Ejemplos=====
 
=====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&other=bW9kdWxlX2JlZ2luCm1vZHVsZV9uYW1lIGV4YW1wbGVfbmFtZQptb2R1bGVfdHlwZSBnZW5lcmljX2RhdGEKbW9kdWxlX2V4ZWMgZWNobyAxOwptb2R1bGVfZW5k
+
  <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>
  
Se retornará '0' en caso de éxito,'-1' en caso de error, '-2' si ya existe
+
====set add_user_profile====
 
+
Añade un perfil a un usuario.
====set delete_module_in_conf====
 
>= 5.0 (Sólo Enterprise)
 
 
 
Borra la configuración de un módulo local.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=add_module_in_conf (obligatorio)
+
*op2=add_user_profile (obligatorio)
*id=&lt;id agente&gt; (obligatorio)
+
*id=&lt;nombre_usuario&gt; (obligatorio) debe ser un nombre usuario.
*id2=&lt;nombre módulo&gt; (obligatorio)
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del grupo y profile, serializados en el siguiente orden:
 +
:*&lt;grupo&gt;
 +
:*&lt;profile&gt;
  
 
=====Ejemplos=====
 
=====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
+
  <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>
  
Se retornará '0' en caso de éxito ó '-1' en caso de error
+
====set delete_user_profile====
 
+
Quita un perfil a un usuario.
====set update_module_in_conf====
 
>= 5.0 (Sólo Enterprise)
 
 
 
Actualiza la configuración de un módulo local.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=update_module_in_conf (obligatorio)
+
*op2=delete_user_profile (obligatorio)
*id=&lt;id agente&gt; (obligatorio)
+
*id=&lt;nombre_usuario&gt; (obligatorio) debe ser un nombre usuario.
*id2=&lt;nombre módulo&gt; (obligatorio)
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del grupo y profile, serializados en el siguiente orden:
*other: los nuevos datos del modulo que irán en el fichero de configuración codificados en base64 (obligatorio)
+
:*&lt;grupo&gt;
 +
:*&lt;profile&gt;
  
 
=====Ejemplos=====
 
=====Ejemplos=====
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_module_in_conf&user=admin&pass=pandora&id=9043&id2=example_name&other=bW9kdWxlX2JlZ2luCm1vZHVsZV9uYW1lIGV4YW1wbGVfbmFtZQptb2R1bGVfdHlwZSBnZW5lcmljX2RhdGEKbW9kdWxlX2V4ZWMgZWNobyAxOwptb2R1bGVfZW5k
+
  <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>
  
Se retornará '1' si no cambia, '0' en caso de éxito, '-1' en caso de error, '-2' si no existe
+
====set new_incident====
 +
Crea un nuevo incidente.
  
====set create_event====
+
Sintaxis de la llamada:
 +
*op=set (obligatorio)
 +
*op2=new_incident (obligatorio)
 +
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del incidente, serializados en el siguiente orden:
 +
:*&lt;titulo&gt;
 +
:*&lt;descripción&gt;
 +
:*&lt;origen&gt;
 +
:*&lt;prioridad&gt;
 +
:*&lt;estado&gt;
 +
:*&lt;grupo&gt;
  
Crea un evento nuevo en Pandora.
+
=====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>
  
{{metaconsola}}
+
====set new_note_incident====
 +
Crea una nota dentro de una incidencia.
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=create_event (obligatorio)
+
*op2=new_note_incident (obligatorio)
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del evento, serializados en el siguiente orden:
+
*id=&lt;id_incidente&gt; (obligatorio) el id del incidente.
:*&lt;event_text&gt; (obligatorio)
+
*id2=&lt;nombre_usuario&gt; (obligatorio) el nombre del usuario.
:*&lt;id_group&gt; (obligatorio)
+
*other=&lt;nota&gt; (obligatorio) es la nota codificada en url encode.
:*&lt;id_agent&gt; (obligatorio)
 
:*&lt;status&gt;
 
:*&lt;id_user&gt;
 
:*&lt;event_type&gt;
 
:*&lt;severity&gt;
 
:*&lt;id_agent_module&gt;
 
:*&lt;id_alert_am&gt;
 
:*&lt;critical_instructions&gt;
 
:*&lt;warning_instructions&gt;
 
:*&lt;unknown_instructions&gt;
 
:*&lt;comment&gt;
 
:*&lt;source&gt;
 
:*&lt;tags&gt;
 
:*&lt;custom_data&gt; Los datos personalizados se introducen como un documento JSON codificado en base 64.
 
:*&lt;server_id&gt; El nodo de la consola hija (solo para metaconsola).
 
  
 
=====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>
  
http://127.0.0.1/pandora_trunk/include/api.php?op=set&op2=create_event&other=NewEvent|0|189||apiuser|system|1||||||||VMware||eyJBbnN3ZXIgdG8gdGhlIFVsdGltYXRlIFF1ZXN0aW9uIG9mIExpZmUsIHRoZSBVbml2ZXJzZSwgYW5kIEV2ZXJ5dGhpbmciOiA0Mn0=&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora
+
====set validate_all_alerts====
 +
Valida todas las alertas.
  
====set add_event_comment====
+
Sintaxis de la llamada:
 +
*op=set (obligatorio)
 +
*op2=validate_all_alerts (obligatorio)
  
>= 5.1  
+
=====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>
  
Añade un comentario acerca del evento
+
====set validate_all_policy_alerts====
 
+
Valida todas las alertas que vienen de políticas.
{{metaconsola}}
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=add_event_comment (obligatorio)
+
*op2=validate_all_policy_alerts (obligatorio)
*other=&lt;serialized_parameters&gt; (obligatorio) son la configuración y datos del evento, serializados en el siguiente orden:
 
:*&lt;comment&gt; (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>
  
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
+
====set event_validate_filter====
 +
Valida todos los eventos que pasan el filtro pasado como parámetros.
  
====set create_netflow_filter====
 
(>=5.0)
 
  
Crea un nuevo filtro de netflow.
+
{{metaconsola}}
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=create_netflow_filter (obligatorio)
+
*op2=event_validate_filter (obligatorio)
*other=&lt;parámetros serializados&gt; (obligatorio) son los datos del filtro, serializados en el siguiente orden:
+
*other_mode=url_encode_separator_| (opcional)
:*&lt;nombre_filtro&gt; (obligatorio)
+
*other=&lt;parámetros serializados&gt; (opcional), son los siguientes en este orden:
:*&lt;id_grupo&gt; (obligatorio)
+
:*&lt;separator&gt;
:*&lt;filtro&gt; (obligatorio)
+
:*&lt;criticity&gt; De 0 a 4
:*&lt;agregado_por&gt; (Valores posibles: dstip,dstport,none,proto,srcip,srcport)  (obligatorio)
+
:*&lt;nombre agente&gt;
:*&lt;formato_salida&gt; (Valores posibles: kilobytes,kilobytespersecond,megabytes,megabytespersecond) (obligatorio)
+
:*&lt;nombre módulo&gt;
 +
:*&lt;nombre plantilla de alerta&gt;
 +
:*&lt;usuario&gt;
 +
:*&lt;nivel mínimo intervalo numérico &gt; en unix timestamp
 +
:*&lt;nivel máximo intervalo numérico &gt; en unix timestamp
 +
:*&lt;use_agent_name&gt; (Acepta valores 0 y 1)
  
 
=====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>
  
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_|
+
====set event_validate_filter_pro====
 +
Es igual que la anterior.
  
====set create_custom_field====
 
>= 5.0
 
  
Crea un nuevo campo custom.
+
{{metaconsola}}
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=create_custom_field (obligatorio)
+
*op2=event_validate_filter_pro (obligatorio)
*other=&lt;parámetros serializados&gt; (obligatorio) parámetros para configurar el custom field
+
*other_mode=url_encode_separator_| (opcional)
:*&lt;name&gt; (obligatorio)
+
*other=&lt;parámetros serializados&gt; (opcional), son los siguientes en este orden:
:*&lt;flag_display_front&gt; (obligatorio; 0 no se mostrará en la vista de operación, 1 si se mostrará)
+
:*&lt;separator&gt;
 +
:*&lt;criticity&gt; De 0 a 4
 +
:*&lt;id agente&gt;
 +
:*&lt;id modulo&gt;
 +
:*&lt;id agente modulo alerta&gt;
 +
:*&lt;usuario&gt;
 +
:*&lt;nivel mínimo intervalo numérico &gt; en unix timestamp
 +
:*&lt;nivel máximo intervalo numérico &gt; en unix timestamp
 +
 
 +
=====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>
  
=====Ejemplo=====
+
====set validate_event_by_id====
  
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
+
Valida un evento según la id que se pase en los parámetros.
  
====set create_tag====
+
Sintaxis de la llamada:
>= 5.0
 
  
Crea un nuevo tag.
+
op=set (obligatorio)
 +
op2=validate_event_by_id (obligatorio)
 +
id=<id_evento> (obligatorio) el id del evento.
  
Sintaxis de la llamada:
+
=====Ejemplos=====
*op=set (obligatorio)
 
*op2=create_tag (obligatorio)
 
*other=&lt;parámetros serializados&gt; (obligatorio) parámetros para configurar el tag
 
:*&lt;name&gt; Nombre del tag (obligatorio)
 
:*&lt;description&gt; Descripción del tag
 
:*&lt;eurl&gt; Url del tag
 
:*&lt;email&gt; Email del tag
 
  
=====Ejemplo=====
+
<nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=validate_event_by_id&id=23&apipass=1234&user=admin&pass=pandora</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
+
====set new_alert_template====
 +
Aplica una alerta desde una plantilla y un módulo pasado como id de agente y nombre de módulo.
  
====set enable_disable_agent====
 
 
Activa un agente desactivado.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=enable_disable_agent (obligatorio)
+
*op2=new_alert_template (obligatorio)
*id=&lt;id_agente&gt; (obligatorio) debe ser un id agente.
+
*id=&lt;nombre del agente&gt; (obligatorio)
 +
*id2=&lt;nombre de la plantilla de alerta&gt; (obligatorio)
 +
*other_mode=url_encode_separator_| (opcional)
 +
*other=&lt;parámetros serializados&gt; (obligatorio), son los siguientes en este orden:
 +
:*&lt;nombre modulo&gt; (obligatorio)
 +
:*&lt;use_agent_alias&gt; (Acepta valores 0 y 1)
  
 
=====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>
  
Example 1 (Disable agent 'example_id')
+
====set alert_actions====
 
+
Añade acciones a una alerta.
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
 
 
 
====set gis_agent_only_position====
 
>= 5.0
 
 
 
Añade solo la posicion GIS a un agente.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=gis_agent_only_position (obligatorio)
+
*op2=alert_actions (obligatorio)
*id=<índice> (obligatorio) debe ser un índice de un agente.
+
*id=&lt;nombre del agente&gt; (obligatorio)
*other=&lt;parámetros serializados&gt; (obligatorio) parámetros para configurar el Gis
+
*id2=&lt;nombre de la plantilla de alerta&gt; (obligatorio)
:*&lt;latitude&gt; Latitud
+
*other_mode=url_encode_separator_| (opcional)
:*&lt;longitude&gt; Longitud
+
*other=&lt;parámetros serializados&gt; (obligatorio), son los siguientes en este orden:
:*&lt;altitude&gt; Altitud
+
:*&lt;nombre modulo&gt; (obligatorio)
 +
:*&lt;nombre acción&gt; (obligatorio)
 +
:*&lt;fires min &gt; (opcional)
 +
:*&lt;fires max &gt; (opcional)
 +
:*&lt;use_agent_alias&gt; (Acepta valores 0 y 1)
  
=====Ejemplo=====
+
=====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>
  
  http://127.0.0.1/pandora5/include/api.php?apipass=caca&user=admin&pass=pandora&op=set&op2=gis_agent_only_position&id=582&other_mode=url_encode_separator_|&other=2%7C1%7C0
+
  <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 gis_agent====
+
====set alert_commands====
>= 5.0
+
Añade comandos a una alerta.
 
 
Añade los datos GIS a un agente.
 
  
 
Sintaxis de la llamada:
 
Sintaxis de la llamada:
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=gis_agent_only_position (obligatorio)
+
*op2=alert_commands (obligatorio)
*id=<índice> (obligatorio) debe ser un índice de un agente.
+
*id=&lt;nombre del comando&gt; (obligatorio)
*other=&lt;parámetros serializados&gt; (obligatorio) parámetros para configurar el gis
+
*other_mode=url_encode_separator_| (opcional)
:*&lt;latitude&gt; Latitud
+
*other=&lt;parámetros serializados&gt; (obligatorio), son los siguientes en este orden:
:*&lt;longitude&gt; Longitud
+
:*&lt;command&gt; (obligatorio)
:*&lt;altitude&gt; Altitud
+
:*&lt;id_group&gt; (obligatorio)
:*&lt;ignore_new_gis_data&gt; ignorar nuevos datos gis
+
:*&lt;description &gt; (opcional)
:*&lt;manual_placement&gt; posicionamiento manual
+
:*&lt;internal &gt; (opcional)
:*&lt;start_timestamp&gt; tiempo de comienzo en esta posicion
+
:*&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;end_timestamp&gt; tiempo de finalización de la anterior
 
:*&lt;number_of_packages&gt; numero de paquetes en esta posición
 
:*&lt;description_save_history&gt; descripción
 
:*&lt;description_update_gis&gt; descripción
 
:*&lt;description_first_insert&gt; descripción
 
  
 +
=====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>
  
 +
====set new_module====
 +
Crea un nuevo módulo.
  
 +
Sintaxis de la llamada:
 +
*op=set (obligatorio)
 +
*op2=new_module (obligatorio)
 +
*id=&lt;nombre del agente&gt; (obligatorio)
 +
*id2=&lt;nombre del nuevo modulo&gt; (obligatorio)
 +
*other_mode=url_encode_separator_| (opcional)
 +
*other=&lt;parámetros serializados&gt; (obligatorio), son los siguientes en este orden:
 +
:*&lt;tipo de modulo de red&gt; (obligatorio)
 +
:*&lt;nombre acción&gt; (obligatorio)
 +
:*&lt;ip o url &gt; (obligatorio)
 +
:*&lt;puerto &gt; (opcional)
 +
:*&lt;descripción &gt; (opcional)
 +
:*&lt;min &gt; (opcional)
 +
:*&lt;max &gt; (opcional)
 +
:*&lt;post process &gt; (opcional)
 +
:*&lt;module interval &gt; (opcional)
 +
:*&lt;min warning &gt; (opcional)
 +
:*&lt;max warning &gt; (opcional)
 +
:*&lt;min critical &gt; (opcional)
 +
:*&lt;max critical &gt; (opcional)
 +
:*&lt;history data &gt; (opcional)
 +
:*&lt;enable_unknown_events&gt; (solo versión 5)
 +
:*&lt;use_agent_alias&gt; (Acepta valores 0 y 1)
  
=====Ejemplo=====
+
=====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>
  http://127.0.0.1/pandora5/include/api.php?apipass=caca&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
 
  
 +
====set delete_module====
 +
Borra un módulo.
 +
 +
Sintaxis de la llamada:
 +
*op=set (obligatorio)
 +
*op2=delete_module (obligatorio)
 +
*id=&lt;nombre del agente&gt; (obligatorio)
 +
*id2=&lt;nombre del modulo&gt; (obligatorio)
 +
*other=simulate (opcional)
 +
:*&lt;use_agent_alias&gt; (Acepta valores 0 y 1)
  
====set create_special_day====
+
=====Ejemplos=====
>= 5.1
+
<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&other_mode=url_encode_separator_|</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&other_mode=url_encode_separator_|</nowiki>
  
Permite añadir un día especial.
+
====set enable_alert====
 +
Activa una alerta dentro de un agente.
  
Sintaxis:
+
Sintaxis de la llamada:
  
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=create_special_day (obligatorio)
+
*op2=enable_alert
*other=&lt;parámetros serializados&gt; (obligatorio)
+
*id=&lt;Nombre del agente&gt; (obligatorio)
:*&lt;special day&gt; Día especial
+
*id2=&lt;Nombre del modulo&gt; (obligatorio)
:*&lt;same day&gt; Mismo día
+
*other: nombre del template de la alerta (p.e: Warning event) (obligatorio)
:*&lt;description&gt; Descripción
 
:*&lt;id_group&gt; Id Grupo
 
  
=====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
+
===== 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>
  
====set update_special_day====
+
====set enable_alert_alias====
>= 5.1
+
Activa una alerta dentro de un agente a partir del alias.
  
Actualizar configuración de un día especial ya definido.
+
Sintaxis de la llamada:
 
 
Sintaxis:
 
  
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=update_special_day (obligatorio)
+
*op2=enable_alert_alias
*id=&lt;id día especial&gt; (obligatorio)
+
*id=&lt;Alias del agente&gt; (obligatorio)
*other=&lt;parámetros serializados&gt; (obligatorio)
+
*id2=&lt;Nombre del modulo&gt; (obligatorio)
:*&lt;special day&gt; Día especial
+
*other: nombre del template de la alerta (p.e: Warning event) (obligatorio)
:*&lt;same day&gt; Mismo día
 
:*&lt;description&gt; Descripción
 
:*&lt;id_group&gt; Id grupo
 
  
=====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
+
===== 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>
  
 +
====set disable_alert====
 +
Desactiva una alerta dentro de un agente.
  
====set delete_special_day====
+
Sintaxis de la llamada:
>= 5.1
 
 
 
Permite borrar un día especial.
 
 
 
Sintaxis:
 
  
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=delete_special_day (obligatorio)
+
*op2=disable_alert
*id=&lt;id día especial&gt; (obligatorio)
+
*id=&lt;Nombre del agente&gt; (obligatorio)
 +
*id2=&lt;Nombre del modulo&gt; (obligatorio)
 +
*other: nombre del template de la alerta (p.e: Warning event) (obligatorio)
  
=====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
+
===== 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>
  
====set pagerduty_webhook====
+
====set disable_alert_alias====
>= 5.1
+
Desactiva una alerta dentro de un agente.
  
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 de la llamada:
 
 
Sintaxis:
 
  
 
*op=set (obligatorio)
 
*op=set (obligatorio)
*op2=pagerduty_webhook (obligatorio)
+
*op2=disable_alert_alias
*id=alert (obligatorio)
+
*id=&lt;Alias del agente&gt; (obligatorio)
 +
*id2=&lt;Nombre del modulo&gt; (obligatorio)
 +
*other: nombre del template de la alerta (p.e: Warning event) (obligatorio)
  
=====Ejemplo=====
 
  
  http://127.0.0.1/pandora_console/include/api.php?op=set&op2=pagerduty_webhook&apipass=1234&user=admin&pass=pandora&id=alert
+
===== 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>
  
====set tag_user_profile====
+
====set enable_module_alerts====
>= 6
+
Igual que la llamada enable_alert.
  
Añade un tag a un perfil de un usuario.
+
Sintaxis de la llamada:
  
Sintaxis:
+
*op=set (obligatorio)
 +
*op2=enable_module_alerts
 +
*id=&lt;Nombre del agente&gt; (obligatorio)
 +
*id2=&lt;Nombre del modulo&gt; (obligatorio)
 +
*other (opcional)=&lt;use_agent_alias&gt; (Acepta valores 0 y 1)
  
* op = set (obligatorio)
+
===== Ejemplo =====
* op2 = tag_user_profile (obligatorio)
+
<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>
* id = id_usuario (obligatorio)
 
* id2 = id_etiqueta (obligatorio)
 
* other_mode = url_encode_separator_| (obligatorio)
 
* other = <id_grupo>|<id_perfil> (obligatorio)
 
  
 +
====set disable_module_alerts====
 +
Igual que la llamada disable_alert.
  
=====Ejemplo=====
+
Sintaxis de la llamada:
 +
 
 +
*op=set (obligatorio)
 +
*op2=disable_module_alerts
 +
*id=&lt;Nombre del agente&gt; (obligatorio)
 +
*id2=&lt;Nombre del modulo&gt; (obligatorio)
 +
*other (opcional)=&lt;use_agent_alias&gt; (Acepta valores 0 y 1)
  
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
 
  
====set tag====
+
===== Ejemplo =====
>= 6
+
<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>
  
Añade un tag a tu pandora.
+
====set enable_module====
 +
Activa el módulo.
  
Sintaxis:
+
Sintaxis de la llamada:
  
* op = set (obligatorio)
+
*op=set (obligatorio)
* op2 = tag (obligatorio)
+
*op2=enable_module
* id = nombre (obligatorio)
+
*id=&lt;Nombre del agente&gt; (obligatorio)
* other_mode = url_encode_separator_| (obligatorio)
+
*id2=&lt;Nombre del modulo&gt; (obligatorio)
* other = <descripción>|<url>|<email>|<teléfono>
+
*other (opcional)=&lt;use_agent_alias&gt; (Acepta valores 0 y 1)
  
  
=====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>
  
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].es|01189998819991197253
+
====set disable_module====
 +
Desactiva el módulo.
  
====set add_tag_module====
+
Sintaxis de la llamada:
>= 6
 
  
Añade un tag a un módulo.
+
*op=set (obligatorio)
 +
*op2=disable_module
 +
*id=&lt;Nombre del agente&gt; (obligatorio)
 +
*id2=&lt;Nombre del modulo&gt; (obligatorio)
 +
*other (opcional)=&lt;use_agent_alias&gt; (Acepta valores 0 y 1)
  
Sintaxis:
 
  
* op = set (obligatorio)
+
===== Ejemplo =====
* op2 = add_tag_module (obligatorio)
+
<nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=disable_module&id=example&id2=Status&apipass=1234&user=admin&pass=pandora</nowiki>
* id = id_modulo (obligatorio)
 
* id2 = id_tag (obligatorio)
 
  
 +
====set create_network_module_from_component====
 +
Crea un nuevo módulo de red desde un componente.
  
=====Ejemplo=====
+
Sintaxis de la llamada:
  
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
+
*op=set (obligatorio)
 +
*op2=create_network_module_from_component (obligatorio)
 +
*id=&lt;Nombre del agente&gt; (obligatorio)
 +
*id2=&lt;Nombre del componente&gt; (obligatorio)
 +
*other (opcional)=&lt;use_agent_alias&gt; (Acepta valores 0 y 1)
  
====set remove_tag_module====
 
>= 6
 
  
Quita un tag a un módulo.
+
===== 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>
  
Sintaxis:
+
====set module_data====
 +
Añade un nuevo valor al módulo. Esta llamada únicamente genera un XML con los datos que se enviarán al servidor, que será el encargado de hacer la actualización en la Base de Datos.
  
* op = set (obligatorio)
+
Solamente se controla la generación del fichero XML, devolviendo un mensaje relacionado con ese proceso.
* op2 = add_tag_module (obligatorio)
 
* id = id_modulo (obligatorio)
 
* id2 = id_tag (obligatorio)
 
  
 +
Sintaxis de la llamada:
 +
*op=set (obligatorio)
 +
*op2=module_data (obligatorio)
 +
*id=&lt;id agente módulo&gt; (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.
  
=====Ejemplo=====
+
=====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>
  
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
+
{{Warning|La generación exitosa del fichero XML no garantiza que la información haya quedado almacenada en la base de datos.}}
  
 +
====set new_module_group====
 +
Crea un nuevo grupo de módulos.
  
 +
Sintaxis de la llamada:
 +
*op=set (obligatorio)
 +
*op2=new_module_group (obligatorio)
 +
*id=&lt;nombre del grupo de módulos&gt; (obligatorio)
  
====set planned_downtimes_created====
+
=====Ejemplos=====
>= 5.1
+
<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>
  
Crea una parada planificada.
+
====set module_group_synch====
 +
{{metaconsola}}
 +
Sincronizar grupo de módulos desde la metaconsola.
  
*op=set
+
Sintaxis de la llamada:
*op2=planned_downtimes_created
+
*op=set (obligatorio)
*other=<description>;<date_from>;<date_to>;<id_group>;<monday>;
+
*op2=module_group_synch (obligatorio)
* <tuesday>;<wednesday>;<thursday>;<friday>;<saturday>;<sunday>;<periodically_time_from>;<periodically_time_to>;
+
*other=&lt;parámetros serializados&gt; (obligatorio) en este caso el nombre del/de los servidor/es que se quiere/n sincronizar con la meta.
*  <periodically_day_from>;<periodically_day_to>;<type_downtime>;<type_execution>;<type_periodicity>;
+
:*&lt;server_name_1&gt;&lt;server_name_2&gt;...&lt;server_name_n&gt; (obligatorio)
  
=====Ejemplo=====
+
=====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>
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_created&id=pepito&other=testing
+
====set add_module_in_conf====
|08/04/2015|08/31/2015|0|1|1|1|1|1|1|1|17:06:00|19:06:00|1|31|quiet|periodically|weekly
+
>= 5.0 (Sólo Enterprise)
&other_mode=url_encode_separator_|
 
  
====set planned_downtimes_additem====
+
Añade una configuración a un módulo local.
>= 5.1
 
  
Crea registros para una parada planificada.
+
Sintaxis de la llamada:
*op=set
+
*op=set (obligatorio)
*op2=planned_downtimes_additem
+
*op2=add_module_in_conf (obligatorio)
*id=planned_downtime_id
+
*id=&lt;id agente&gt; (obligatorio)
*other= <id_agent1;id_agent2;id_agent3;....id_agentn;>;<name_module1;name_module2;name_module3;......name_modulen;>
+
*id2=&lt;nombre módulo&gt; (obligatorio)
 +
*other: los datos del modulo que irán en el fichero de configuración codificados en base64 (obligatorio)
  
=====Ejemplo=====
+
=====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>
  
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_additem&id=123&other=1;2;3;4|Status;Unkown_modules
+
Se retornará '0' en caso de éxito,'-1' en caso de error, '-2' si ya existe
&other_mode=url_encode_separator_|
 
  
====set planned_downtimes_deleted====
+
====set delete_module_in_conf====
>=5.1
+
>= 5.0 (Sólo Enterprise)
  
Elimina una parada planificada.
+
Borra la configuración de un módulo local.
*op=set
 
*op2=planned_downtimes_deleted
 
*id=planned_downtime_id
 
  
=====Ejemplo=====
+
Sintaxis de la llamada:
 
+
*op=set (obligatorio)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=planned_downtimes_deleted &id=10
+
*op2=add_module_in_conf (obligatorio)
 +
*id=&lt;id agente&gt; (obligatorio)
 +
*id2=&lt;nombre módulo&gt; (obligatorio)
  
====set create_synthetic_module====
+
=====Ejemplos=====
>=5.1SP4
+
<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>
  
Crea un módulo sintetico:
+
Se retornará '0' en caso de éxito ó '-1' en caso de error
*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:
+
====set update_module_in_conf====
  En las creación de tipo arithmetic el primer dato si es Agente y modulo sin operador : AgentName;NameModule. Si es un valor: <Operation;Value>. El resto de valores irian ya de la forma siguiente: <AgentName;Operation;NameModule> or <Operation;Value>
+
>= 5.0 (Sólo Enterprise)
  average: <AgentName;Operation;NameModule> or <Operation;Value>
 
  
**Operaciones:
+
Actualiza la configuración de un módulo local.
  arithmetic: ADD, SUB, MUL, DIV
 
  average: Only AVG
 
  
=====Ejemplo=====
+
Sintaxis de la llamada:
**http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_synthetic_module&id=test
+
*op=set (obligatorio)
&other=Test|arithmetic|Agent%20Name;Module%20Name|Agent%20Name2;
+
*op2=update_module_in_conf (obligatorio)
ADD;Module%20Name2&other_mode=url_encode_separator_|
+
*id=&lt;id agente&gt; (obligatorio)
OR
+
*id2=&lt;nombre módulo&gt; (obligatorio)
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=create_synthetic_module&id=pepito&other=prueba|average|Agent%20Name;AVG;
+
*other: los nuevos datos del módulo que irán en el fichero de configuración codificados en base64 (obligatorio)
Name%20Module|Agent%20Name2;AVG;Name%20Module2&other_mode=url_encode_separator_|
 
  
== 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>
  
Distintos ejemplos simples de llamada al API en distintos lenguajes.
+
Se retornará '1' si no cambia, '0' en caso de éxito, '-1' en caso de error, '-2' si no existe
  
=====Ejemplo=====
+
====set create_event====
 +
Crea un evento nuevo en Pandora.
  
http://127.0.0.1/pandora5/include/api.php?apipass=caca&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
 
  
 +
{{metaconsola}}
  
=== PHP ===
+
Sintaxis de la llamada:
<pre>
+
*op=set (obligatorio)
<?php
+
*op2=create_event (obligatorio)
$ip = '192.168.70.110';
+
*other=&lt;parámetros serializados&gt; (obligatorio) son la configuración y datos del evento, serializados en el siguiente orden:
$pandora_url = '/pandora5';
+
:*&lt;event_text&gt; (obligatorio)(string)
$apipass = '1234';
+
:*&lt;id_group&gt; (obligatorio)(string)
$user = 'admin';
+
:*&lt;id_agent&gt; (obligatorio)(numeric)
$password = 'pandora';
+
:*&lt;status&gt;(0 New, 1 Validated, 2 In process)
$op = 'get';
+
:*&lt;id_user&gt;(numeric)
$op2 = 'all_agents';
+
:*&lt;event_type&gt;(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)
$return_type = 'csv';
+
:*&lt;severity&gt; (0 Maintenance,1 Informative,2 Normal,3 Warning,4 Crit,5 Minor, 6 Major)
$other = '';
+
:*&lt;id_agent_module&gt;(numeric)
$other_mode = '';
+
:*&lt;id_alert_am&gt;(numeric)
 +
:*&lt;critical_instructions&gt;(string)
 +
:*&lt;warning_instructions&gt;(string)
 +
:*&lt;unknown_instructions&gt;(string)
 +
:*&lt;comment&gt;(string)
 +
:*&lt;owner_user&gt;(string)
 +
:*&lt;source&gt;(string)
 +
:*&lt;tags&gt;(string)
 +
:*&lt;custom_data&gt; Los datos personalizados se introducen como un documento JSON codificado en base 64.
 +
:*&lt;server_id&gt; El nodo de la consola hija (solo para metaconsola).
 +
:*&lt;id_extra&gt; (alphanumeric)
  
$url = "http://" . $ip . $pandora_url . "/include/api.php";
+
=====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>
  
$url .= "?";
+
====set add_event_comment====
$url .= "apipass=" . $apipass;
+
Añade un comentario acerca del evento
$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();
+
{{Tip|Esta característica se encuentra tanto en nodo como en Metaconsola}}
curl_setopt($curlObj, CURLOPT_URL, $url);
 
curl_setopt($curlObj, CURLOPT_RETURNTRANSFER, 1);
 
$result = curl_exec($curlObj);
 
curl_close($curlObj);
 
  
$agents = array();
+
Sintaxis de la llamada:
if (!empty($result)) {
+
 
$lines = explode("\n", $result);
+
*op=set (obligatorio)
foreach ($lines as $line) {
+
*op2=add_event_comment (obligatorio)
$fields = explode(";", $line);
+
*other=&lt;serialized_parameters&gt; (obligatorio) son la configuración y datos del evento, serializados en el siguiente orden:
+
:*&lt;comment&gt; (obligatorio)
$agent = array();
+
 
$agent['id_agent'] = $fields[0];
+
{{Tip|Para poder utilizarla en Metaconsola, se debe introducir el parámetro true despues del string}}
$agent['name'] = $fields[1];
+
 
$agent['ip'] = $fields[2];
+
=====Ejemplos=====
$agent['description'] = $fields[3];
+
* Nodo:
$agent['os_name'] = $fields[4];
+
 
$agent['url_address'] = $fields[5];
+
<nowiki>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</nowiki>
+
 
$agents[] = $agent;
+
* Metaconsola:
}
+
 
}
+
<nowiki>http://localhost/pandora_console/include/api.php?op=set&op2=event&apipass=1234&user=admin&pass=pandora&id=1&other_mode=url_encode_separator_|&other=estado,0|evento,test</nowiki>
 +
 
 +
====set update_event====
 +
Modifica eventos a través de la API.
  
print_list_agents($agents);
+
{{Tip|Esta característica se encuentra tanto en nodo como en Metaconsola}}
  
function print_list_agents($agents) {
+
Sintaxis de la llamada:
echo "<table border='1' style='empty-cells: show;'>";
+
 
+
*op=set (obligatorio)
echo "<thead>";
+
*op2=event (obligatorio)
echo "<tr>";
+
*id=event_id (obligatorio)
echo "<th>" . "ID" . "</th>";
+
*other=&lt;serialized_parameters&gt; (obligatorio) son los datos del evento a actualizar.
echo "<th>" . "Name" . "</th>";
+
*&lt;comment&gt; (obligatorio)
echo "<th>" . "IP" . "</th>";
+
 
echo "<th>" . "Description" . "</th>";
+
 
echo "<th>" . "OS" . "</th>";
+
 
echo "<th>" . "URL" . "</th>";
+
=====Ejemplos=====
echo "</tr>";
+
* Nodo:
echo "</thead>";
+
 
+
<nowiki>http://192.168.80.190/pandora_console/include/api.php?op=set&op2=event&apipass=pandora&user=admin&pass=pandora&id=175&other_mode=url_encode_separator_|&other=estado,2|evento,cambiadito2</nowiki>
foreach ($agents as $agent) {
+
 
echo "<tr>";
+
* Metaconsola:
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>";
 
}
 
?>
 
</pre>
 
  
=== Python ===
+
<nowiki>http://192.168.80.35/pandora_console/include/api.php?op=set&op2=event&apipass=1234&user=admin&pass=t3st1ng!&id=315132&other_mode=url_encode_separator_|&other=estado,0|evento,pepe|custom_data,1</nowiki>
<pre>
 
import pycurl
 
import cStringIO
 
import pprint
 
  
def main():
+
====set create_netflow_filter====
ip = '192.168.70.110'
+
(>=5.0)
pandora_url = '/pandora5'
+
 
apipass = '1234'
+
Crea un nuevo filtro de netflow.
user = 'admin'
+
 
password = 'pandora'
+
Sintaxis de la llamada:
op = 'get'
+
*op=set (obligatorio)
op2 = 'all_agents'
+
*op2=create_netflow_filter (obligatorio)
return_type = 'csv'
+
*other=&lt;parámetros serializados&gt; (obligatorio) son los datos del filtro, serializados en el siguiente orden:
other = ''
+
:*&lt;nombre_filtro&gt; (obligatorio)
other_mode = ''
+
:*&lt;id_grupo&gt; (obligatorio)
+
:*&lt;filtro&gt; (obligatorio)
url = "http://" + ip  + pandora_url + "/include/api.php"
+
:*&lt;agregado_por&gt; (Valores posibles: dstip,dstport,none,proto,srcip,srcport)  (obligatorio)
+
:*&lt;formato_salida&gt; (Valores posibles: kilobytes,kilobytespersecond,megabytes,megabytespersecond) (obligatorio)
url += "?"
+
 
url += "apipass=" + apipass
+
=====Ejemplos=====
url += "&user="  + user
+
<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>
url += "&pass=" + password
+
 
url += "&op=" + op
+
====set create_custom_field====
url += "&op2=" + op2
+
>= 5.0
+
 
buf = cStringIO.StringIO()
+
Crea un nuevo campo custom.
 
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__":
+
Sintaxis de la llamada:
    main()
+
*op=set (obligatorio)
</pre>
+
*op2=create_custom_field (obligatorio)
 +
*other=&lt;parámetros serializados&gt; (obligatorio) parámetros para configurar el custom field
 +
:*&lt;name&gt; (obligatorio)
 +
:*&lt;flag_display_front&gt; (obligatorio; 0 no se mostrará en la vista de operación, 1 si se mostrará)
  
 +
=====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>
 +
 +
====set create_tag====
 +
>= 5.0
  
=== Perl ===
+
Crea un nuevo tag.
<pre>
 
use strict;
 
use warnings;
 
use WWW::Curl::Easy;
 
  
sub write_callback {
+
Sintaxis de la llamada:
my ($chunk,$variable) = @_;  
+
*op=set (obligatorio)
+
*op2=create_tag (obligatorio)
push @{$variable}, $chunk;  
+
*other=&lt;parámetros serializados&gt; (obligatorio) parámetros para configurar el tag
return length($chunk);
+
:*&lt;name&gt; Nombre del tag (obligatorio)
}
+
:*&lt;description&gt; Descripción del tag
 +
:*&lt;eurl&gt; Url del tag
 +
:*&lt;email&gt; Email del tag
  
my $ip = '192.168.70.110';
+
=====Ejemplo=====
my $pandora_url = '/pandora5';
+
<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>
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";
+
====set enable_disable_agent====
$url .= "?";
+
Activa un agente desactivado.
$url .= "apipass=" . $apipass;
 
$url .= "&user=" . $user;
 
$url .= "&pass=" . $password;
 
$url .= "&op=" . $op;
 
$url .= "&op2=" . $op2;
 
  
my @body;
+
Sintaxis de la llamada:
  
my $curl = WWW::Curl::Easy->new;
+
*op=set (obligatorio)
$curl->setopt(CURLOPT_URL, $url);
+
*op2=enable_disable_agent (obligatorio)
$curl->setopt(CURLOPT_WRITEFUNCTION, \&write_callback);
+
*id=&lt;id_agente&gt; (obligatorio) debe ser un id agente.
$curl->setopt(CURLOPT_FILE, \@body);  
 
$curl->perform();
 
  
my $body=join("",@body);
+
=====Ejemplos=====
my @lines = split("\n", $body);
+
Example 1 (Disable agent 'example_id')  
  
foreach my $line (@lines) {
+
<nowiki>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</nowiki>
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");
 
}
 
</pre>
 
  
=== Ruby ===
+
Example 2 (Enable agent 'example_id')
<pre>
+
 
require 'open-uri'
+
<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>
  
ip = '192.168.70.110'
+
====set gis_agent_only_position====
pandora_url = '/pandora5'
+
>= 5.0
apipass = '1234'
+
 
user = 'admin'
+
Añade solo la posición GIS a un agente.
password = 'pandora'
+
 
op = 'get'
+
Sintaxis de la llamada:
op2 = 'all_agents'
+
*op=set (obligatorio)
return_type = 'csv'
+
*op2=gis_agent_only_position (obligatorio)
other = ''
+
*id=<índice> (obligatorio) debe ser un índice de un agente.
other_mode = ''
+
*other=&lt;parámetros serializados&gt; (obligatorio) parámetros para configurar el Gis
 +
:*&lt;latitude&gt; Latitud
 +
:*&lt;longitude&gt; Longitud
 +
:*&lt;altitude&gt; Altitud
  
url = "http://" + ip  + pandora_url + "/include/api.php"
+
=====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>
  
url += "?"
+
====set gis_agent====
url += "apipass=" + apipass
+
>= 5.0
url += "&user="  + user
 
url += "&pass=" + password
 
url += "&op=" + op
 
url += "&op2=" + op2
 
  
agents = []
+
Añade los datos GIS a un agente.
  
open(url) do |content|
+
Sintaxis de la llamada:
+
*op=set (obligatorio)
content.each do |line|
+
*op2=gis_agent_only_position (obligatorio)
agent = {}
+
*id=<índice> (obligatorio) debe ser un índice de un agente.
+
*other=&lt;parámetros serializados&gt; (obligatorio) parámetros para configurar el gis
tokens = line.split(";")
+
:*&lt;latitude&gt; Latitud
+
:*&lt;longitude&gt; Longitud
agent[:id_agent] = tokens[0]
+
:*&lt;altitude&gt; Altitud
agent[:name] = tokens[1]
+
:*&lt;ignore_new_gis_data&gt; ignorar nuevos datos gis
agent[:ip] = tokens[2]
+
:*&lt;manual_placement&gt; posicionamiento manual
agent[:description] = tokens[3]
+
:*&lt;start_timestamp&gt; tiempo de comienzo en esta posicion
agent[:os_name] = tokens[4]
+
:*&lt;end_timestamp&gt; tiempo de finalización de la anterior
agent[:url_address] = tokens[5]
+
:*&lt;number_of_packages&gt; numero de paquetes en esta posición
+
:*&lt;description_save_history&gt; descripción
agents.push agent
+
:*&lt;description_update_gis&gt; descripción
end
+
:*&lt;description_first_insert&gt; descripción
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
 
</pre>
 
  
=== Lua ===
 
<pre>
 
require("curl")
 
  
local content = ""
+
=====Ejemplo=====
 +
<nowiki>http://127.0.0.1/pandora5/include/api.php?apipass=1234&user=admin&pass=pandora&op=se