API Externa

La API externa de Pandora FMS se utiliza haciendo llamadas remotas (vía HTTP o HTTPS) 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 de su aplicación usará para realizar operaciones.

Una llamada al API es tan fácil como:

http://<Pandora FMS Console install>/include/api.php<parameters>

El API sólo puede recibir los siguientes parámetros (< parameters >):

• op (obligatorio): Es el primer parámetro. Especifica la naturaleza de la operación que puede ser get o set o help:
  • get: Devuelve un valor o valores
  • set: Envía un valor o valores
  • help: Devuelve una pequeña ayuda de las llamadas
• op2 (obligatorio): La llamada en sí con un nombre explicativo de sobre qué actúa.
• id (depende del comando): Primer parámetro de la llamada.
• id2 (depende del comando): Segundo parámetro de la llamada.
• other (depende del comando): Tercer parámetro de la llamada, algunas veces puede ser un lista de valores serializados.
• other_mode (depende del comando): Formato de la serialización. Lista de valores posibles:
  • url_encode: El valor de other es un alfanumérico formateado como UrlEncode.
  • url_encode_separator_<separador>:El valor será una lista de valores serializados con el carácter separador por ejemplo:

...other=pears|melons|watermelon&other_mode=url_encode_separator_|

• returnType (depende del comando): Formato de retorno del valor o valores. Alguno de los valores disponibles actuales son:
  • string: Devuelve el valor tal cual como un alfanumérico.
  • csv: Devuelve los valores como un CSV separado por defecto con el carácter ; los campos, y separados con retornos de carro las filas.
  • csv_head: Devuelve, igual que con csv, salvo que añade una primera fila con los nombres de los campos a retornar.
• Credenciales de seguridad: véase la sección “Seguridad”.

La API autentifica el acceso mediante origen y/o contraseña de API y/o credenciales de usuario.

Actualmente, la seguridad se basa en una lista de direcciones IP que tendrán acceso a la herramienta.

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

También se puede establecer una contraseña (·API password) para realizar las acciones del API.

• apipass: Por defecto, y es usado en esta documentación, 1234.

Se accede mediante nombre de usuario y contraseña; adicionalmente desde la versión 768 o posterior es posible autenticar mediante bearer token.

Para acceder a las acciones de la API, también es necesario proporcionar un nombre de usuario tipo superadmin y contraseña válidos ambos en el sistema Pandora FMS.

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

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

En esta documentación se utiliza 1234 para la contraseña del API, el nombre de usuario es admin (tipo superadmin) y la contraseña es pandora.

Vea la sintaxis de llamada:

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

• La dirección IP de origen está en la lista de ACL (o se utiliza * para ello).
• La contraseña de la API no está establecida o es 1234.
• El usuario admin existe, es un superadmin y su contraseña de usuario es pandora .

Menú Management → Admin tools → API checker.

Se implementa gracias a tres elementos:

• Filtrado por dirección IP: Solamente las direcciones IP listadas podrán acceder a la API.
• Contraseña global para la API: Si se define, es obligatorio usarla en todas las llamadas.
• Usuario y contraseña: Usuario de tipo superadmin y válido en la Consola web. Se utilizarán sus permisos para cada operación solicitada. A partir de la versión NG 768 también es posible acceder mediante bearer token.

Esto se explica en el siguiente diagrama de flujo:

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

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

La autenticación basada en bearer token permite que cada uno de los usuarios registrados en Pandora FMS pueda generar su propio identificador en correspondencia unívoca. Dicho bearer token debe ser insertado en las cabeceras HTTP, es decir, no forma parte de la URL completa de la API. El mecanismo de envío corresponde a la aplicación que realiza la conexión con la API de PFMS.

Para los siguientes ejemplos se utiliza el programa de línea de comandos cURL, versión 7.68 .

• Verifique la versión de curl con curl -V.

• Si necesita más ayuda para utilizar curl, invoque curl -h.
• Los parámetros -k y -H sirven para aceptar conexiones con certificados autofirmados para HTTPS y enviar la información de las cabeceras, respectivamente.
• Consulte el bearer token correspondiente al usuario que realizará la consulta API.
• Ahora ya puede realizar una consulta API, en el siguiente ejemplo se utiliza get test (sustituya por su bearer token consultado anteriormente):

BEARER="Authorization: Bearer 811a0c1889f3aa62ef481ccd173ea5ec"
URL="http://192.168.7.117/pandora_console/include/api.php"
API_QUERY="?op=get&op2=test"
curl -k -H "$BEARER" $URL$API_QUERY && echo ""

• Si necesita depurar la conexión utilice el parámetro -v (no confundir con -V usado para mostrar la versión).

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

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

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

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

Un ejemplo de respuesta podría ser: Pandora FMS v7.0NG.768 - PC230120 MR60

Devuelve los datos solicitados.

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

Sintaxis de la llamada: Sin parámetros

Ejemplos

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

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

Un ejemplo de respuesta podría ser: OK,v7.0NG.751,PC201215

Para consultar el estado de la licencia de uso de Pandora FMS, según el nivel de acceso que tenga las credenciales del usuario.

Sintaxis de la llamada:

• op=get (obligatorio).
• op2=license (obligatorio).
• return_type=json (obligatorio).

Ejemplo (vea sintaxis de la llamada):

…/include/api.php?op=get&op2=license&return_type=json&apipass=1234&user=admin&pass=pandora

Para la versión actual devuelve:

{
    "type": "array",
    "data": {
        "expiry_date": "2099/09/04",
        "limit": 200,
        "limit_mode": "0",
        "nms": "0",
        "dhpm": "1",
        "licensed_to": "PandoraFMS(PandoraFMS <[email protected]>)       ",
        "count": "4",
        "count_enabled": "4",
        "count_disabled": "0",
        "license_mode": "Perpetual",
        "expiry_caption": "Support expires"
    }
}

Devuelve una lista de agentes según el filtro en parámetros.

Sintaxis de la llamada:

• op=get (obligatorio).
• op2=all_agents (obligatorio).
• return_type=csv o return_type=json (obligatorio).
• other=< parámetros_serializados > (opcionales). Parámetros serializados para filtrar la búsqueda de agentes:

• < filter_so >
• < filter_group >
• < filter_module_states > unknown, warning, critical, no_modules.
• < filter_alias >
• < filter_policy >
• < csv_separator >
• Recursión (1 o 0).

Ejemplo (vea sintaxis de la llamada):

Este ejemplo devolverá todos los agentes cuyo id_os sea igual a 1 (formato CSV):

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=1||||||0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

Este ejemplo devolverá todos los agentes cuyo id_group sea igual a 2 (formato JSON):

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=json&other=|2|||||0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

Este ejemplo devolverá todos los agentes cuyo estado sea igual a critical (formato CSV):

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=||critical||||0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

Este ejemplo devolverá todos los agentes cuyo alias contenga 'pa' (formato CSV):

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=|||pa|||0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

Este ejemplo devolverá todos los agentes cuya política asociada sea igual a 2 (formato CSV) y recursión:

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=||||2||1&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

Este ejemplo devolverá todos los agentes cuyo id_os sea igual a 1, id_group igual a 2, estado igual a crítico, su alias contenga “pa” y la política asociada sea igual a 2 (formato CSV con separadores @):

…/pandora_console/include/api.php?op=get&op2=all_agents&return_type=csv&other=1|2|critical|pa|2|@|0&other_mode=url_encode_separator_%7C&apipass=1234&user=admin&pass=pandora

= 7.0NG 752

Para consultar el número de Agentes o Módulos disponibles según la licencia de uso de Pandora FMS y de acuerdo a el nivel de acceso que tenga las credenciales del usuario utilizadas.

Sintaxis de la llamada:

• op=get (obligatorio)
• op2= license_remaining (obligatorio)
• return_type = json (obligatorio)

Ejemplos

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

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

Sintaxis de la llamada:

• op=get (obligatorio)
• op2= module_last_value (obligatorio)
• id=<índice> (obligatorio): Debe ser un índice de un módulo agente.
• other =<retorno error> (opcional): Que 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'<separador><código o valor>: Devuelve ese código o valor de error. Pero es necesario acompañarlo de 'other_mode' tal que así other_mode=url_encode_separator_<separador> para pasar el separador en other.

Ejemplos

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

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=<alfanumerico> (obligatorio):Contiene el nombre del agente.
• id2=<alfanumerico> (obligatorio): Contiene el nombre del módulo.
• other =<retorno error> (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'<separador><código o valor>: Devuelve ese código o valor de error. Pero es necesario acompañarlo de 'other_mode' tal que así other_mode=url_encode_separator_<separador> para pasar el separador en other.

Ejemplos

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

= 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 su aplicación detecte este valor fuera del rango de valores que puede ser el módulo.

Sintaxis de la llamada:

• op=get (obligatorio)
• op2=agent_module_name_last_value_alias (obligatorio)
• id=<alfanumerico> (obligatorio): Contiene el alias del agente.
• id2=<alfanumerico> (obligatorio): Contiene el nombre del módulo.
• other =<retorno error> (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'<separador><código o valor>: Devuelve ese código o valor de error. Pero es necesario acompañarlo de 'other_mode' tal que así other_mode=url_encode_separator_<separador> para pasar el separador en other.

Ejemplos

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

Dado el nombre de un módulo, devuelve una lista de agentes que contienen ese nombre de módulo. El resultado devuelve el identificador del agente, alias del mismo, valor del módulo solicitado y nombre del agente, separados por punto y coma (;). Por ejemplo:

653;agente network;0.00000;a8c83b348451040dc91c1327303adf8945aefce6ac59ab9bf856c9f4e0cf6c6f

Sintaxis de la llamada:

• op=get (obligatorio).
• op2=module_value_all_agents (obligatorio).
• id=< nombre_del_módulo > (obligatorio).

Ejemplo (vea sintaxis de la llamada):

Se solicita un listado de todos los agentes que tengan el módulo con nombre Host Alive:

.../include/api.php?op=get&op2=module_value_all_agents&id=Host Alive&apipass=1234&user=admin&pass=pandora

Devuelve la lista de módulos de un agente solicitado por su identificador numérico.

Sintaxis de la llamada:

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

Ejemplo (vea sintaxis de la llamada):

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

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

Sintaxis de la llamada:

• op=get (obligatorio)
• op2=module_id (obligatorio)
• id=id del agente (obligatorio)
• other=nombre del módulo (obligatorio)

Ejemplos

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

Devuelve el valor del campo Custom_id de un módulo concreto de un agente pasando como parámetro el id del módulo.

Sintaxis de la llamada:

• op=get (obligatorio)
• op2=module_custom_id (obligatorio)
• id=id_agente_modulo (obligatorio)

Ejemplos

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

Cambia, o limpia, el valor del campo Custom ID pasando como parámetros el id del módulo y el valor del custom id.

Sintaxis de la llamada:

• op=set (obligatorio)
• op2=module_custom_id (obligatorio)
• id=id_agente_modulo (obligatorio)
• id2=valor, o vacío para limpiar (obligatorio)

Ejemplos

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

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

Sintaxis de la llamada:

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

Ejemplos

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

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

Sintaxis de llamada:

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

Ejemplos

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

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

Sintaxis de la llamada:

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

Ejemplos

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

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

Sintaxis de la llamada:

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

Ejemplos

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

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

Sintaxis de la llamada:

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

Ejemplos

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

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

Sintaxis de la llamada:

• op=get (obligatorio).
• op2=events (obligatorio).
• id=< id del nodo > (opcional en el Command Center -Metaconsola-, innecesario en el nodo).
• return_type=csv o return_type=json (obligatorio).
• other_mode=url_encode_separator_| (obligatorio).
• other=< parámetros serializados > (opcionales), son los siguientes en este orden:
  1. < separador > (obligatorio).
  2. < criticidad > alguno de los siguientes valores desde 0 al número 6:
     1. 0:Maintenance
     2. 1:Informational
     3. 2:Normal
     4. 3:Warning
     5. 4:Critical
     6. 5:Minor
     7. 6:Major
  3. < alias de agente >
  4. < nombre de módulo >
  5. < filtrar por alerta > utilice 1 para filtrar eventos generados por alertas.
  6. < usuario dueño del evento >
  7. < fecha y hora mínima (desde) > en formato de tiempo Unix®, sin milisegundos (EPOCH).
  8. < fecha y hora máxima (hasta) > en formato de tiempo Unix®, sin milisegundos (EPOCH).
  9. < estado > 0 para filtrar eventos no validados, 1 para eventos validados.
  10. < texto > palabra clave a buscar en los eventos.
  11. < tamaño de página > establece el número de registros a devolver para la paginación (offset). Si el número de offset se omite, solamente retribuirá el primer offset (el primer offset es el número cero 0).
  12. < número de página > de acuerdo al tamaño de página del punto anterior, devuelve bloques de registro (offset) anteriores o posteriores.
  13. < estilo > solamente acepta dos valores clave:
      1. total: simplemente devuelve el número total de eventos, por ejemplo en formato JSON entrega: {“type”:“json”,“data”:{“count”:990}}.
      2. more_criticity: devuelve el número de eventos de mayor criticidad, por ejemplo si se le solicita en formato JSON: {“type”:“json”,“data”:[{“criticity”:“4”,“user_can_manage”:“1”,“user_can_write”:“1”,“server_id”:5,“server_name”:“stod”}]}.
  14. < id_grupo > devuelve los eventos no validados pertenecientes a un grupo de agentes, utilice valores numéricos solamente.
  15. < etiqueta > alguna de las tags registradas en PFMS (consulte get tags ). Debe utilizar formato JSON, por ejemplo: [“2”,“5”] (vea sintaxis de la llamada).
  16. < tipo de evento > alguno de los siguientes valores:
      • going_unknown
      • unknown
      • recon_host_detected
      • system
      • error
      • new_agent
      • going_up_warning
      • going_up_critical
      • going_down_warning
      • going_down_normal
      • going_down_critical
      • going_up_normal
      • configuration_change
      • ncm
      • not_normal

Ejemplo (vea sintaxis de la llamada):

Para obtener los eventos ncm (Network configuration manager) por consulta a un Command Center (Metaconsola) cuyo nodo es 5:

…include/api.php?op=get&op2=events&user=admin&pass=pandora&return_type=json&apipass=1234&other_mode=url_encode_separator_|&other=|||||||||||||||ncm&id=5

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

Sintaxis de la llamada:

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

Ejemplos

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

Devuelve la lista de grupos de módulos.

Sintaxis de la llamada:

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

Ejemplos

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

Devuelve la lista de plugins de servidor de Pandora FMS.

Sintaxis de la llamada:

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

Ejemplos

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

Devuelve la lista de etiquetas (tags) definidas en Pandora FMS.

Sintaxis de la llamada:

• op=get (obligatorio)
• op2=tags (obligatorio)
• return_type=csv o return_type=json (obligatorio)
• other=< separador de campos > si solicita en formato CSV debe especificar separador, de lo contrario devolverá los campos juntos.

Ejemplos (vea sintaxis de la llamada):

Este ejemplo devolverá todos los tags del sistema en formato CSV con separador de punto y coma.

…/include/api.php?op=get&op2=tags&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora

Devuelve la configuración de módulo local.

Sintaxis de la llamada:

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

Ejemplos

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

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

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

Sintaxis de la llamada:

• op=get (obligatorio).
• op2=total_modules (obligatorio).
• id=< id grupo > (obligatorio hasta la versión 768; opcional a partir de la versión 769).

Ejemplos (vea la sintaxis de la llamada):

Para obtener el total de módulos en el grupo de módulo Networking

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

Los siguientes grupos de módulos vienen por defecto al instalar Pandora FMS:

1. General.
2. Networking.
3. Application.
4. System.
5. Miscellaneous.
6. Performance.
7. Database.
8. Enviromental.
9. Users.

Si usted coloca 0 como id de grupo, o simplemente lo omite, retornará el número total de módulos:

.../include/api.php?op=get&op2=total_modules&apipass=1234&user=admin&pass=pandora

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

Sintaxis de la llamada:

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

Ejemplos

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

Devuelve el nombre de un agente dado su identificador.

Sintaxis de la llamada:

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

Ejemplos

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

= 7.0NG

Devuelve el alias de un agente dado su identificador.

Sintaxis de la llamada:

• op=get (obligatorio)
• op2=agent_alias (obligatorio)
• id=<id agente> (obligatorio)
• id2=<id del nodo> (obligatorio en el Command Center -Metaconsola-, innecesario en el nodo)

Ejemplos

• Nodo:

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

• Command Center (Metaconsola):

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

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

Sintaxis de la llamada:

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

Ejemplos

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

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

Sintaxis de la llamada:

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

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

Lista todas las acciones de alertas.

Sintaxis de la llamada:

• op=get (obligatorio).
• op2=alert_actions (obligatorio).
• return_type=< tipo_retorno > que puede ser csv o json (obligatorio).
• other=< parámetros_serializados > (opcionales):
  • < nombre_acción >
  • < separador >

Ejemplos

Para obtener el listado de todas las acciones de alertas en formato JSON (vea la sintaxis de la llamada):

.../include/api.php?op=get&op2=alert_actions&return_type=json&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Para obtener el listado de todas las acciones de alertas en formato CSV (vea la sintaxis de la llamada):

.../include/api.php?op=get&op2=alert_actions&return_type=csv&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Lista acciones de alertas de nodos desde el Command Center (Metaconsola).

Sintaxis de la llamada:

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

Ejemplos

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

Devuelve todos los comandos de alertas.

Sintaxis de la llamada:

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

Ejemplos

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

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

Sintaxis de la llamada:

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

Ejemplos

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

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

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

Sintaxis de la llamada:

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

Ejemplo

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

= 5.0

Devuelve la lista de servidores de Pandora FMS que hay.

Sintaxis de la llamada:

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

Example

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

Devuelve los campos en el siguiente orden:

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

Traduce el nombre de un campo personalizado existente al identificador que tiene en la base de datos.

Sintaxis de la llamada:

• op=get (obligatorio).
• op2=custom_field_id (obligatorio).
• other=< parámetro > (obligatorio) en este caso el nombre del campo personalizado.

Ejemplo (vea sintaxis de la llamada):

…/include/api.php?op=get&op2=custom_field_id&other=Serial%20Number&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

= 5.0

Devuelve el último valor GIS de un agente.

Sintaxis de la llamada:

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

Ejemplo

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

= 5.1

Devuelve listado de días especiales.

Sintaxis:

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

Ejemplos

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

= 5.1SP2

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

Sintaxis de la llamada:

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

Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties&id=6233&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties&id=1103&return_type=csv&other=;|   |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

= 5.1SP2

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

Sintaxis de la llamada:

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

Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_name&id=my_agent&id2=my_module&return_type=csv&other=;&apipass=1234&user=admin&pass=pandora
http://127.0.0.1/pandora_console/include/api.php?op=get&op2=module_properties_by_name&id=my_agent&id2=my_module&return_type=csv&other=;|   |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

= 7.0NG

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

Sintaxis de la llamada:

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

Ejemplos

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

Devuelve una gráfica de un Módulo en codificación base64.

Sintaxis de la llamada:

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

• 0 para gráfica en base64, 1 para imagen (obligatorio).
• 0 sin umbrales, 1 con umbrales - si el Módulo tiene umbrales activos - (obligatorio).
• Alto de la gráfica, en píxeles (opcional).
• Ancho de la gráfica, en píxeles (opcional).

Ejemplo

Anterior a versión NG 752:

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

Versión NG 752 o posterior:

http://localhost/pandora_console/include/api.php?op=get&op2=module_graph&id=2&other=3600|1|1|500|800|&other_mode=url_encode_separator_|&apipass=1234&api=1&user=admin&pass=pandora

= 5.1

Devuelve todas los registros coincidentes de paradas planificadas.

• op=get
• op2=all_planned_downtimes
• return_type= CSV o JSON.
• other=<nombre> <id_grupo> <tipo_parada> <tipo ejecución> <tipo de periodicidad> (filtros).

Ejemplo

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

= 5.1

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

• op=get
• op2= planned_downtimes_items
• return_type= CSV o JSON.
• other=<nombre> <grupo> <tipo_parada> <tipo ejecución> <tipo de periodicidad>

Ejemplo

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

= 5.1

devuelve el id de grupo de un agente.

Sintaxis de la llamada:

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

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

= 7.0NG

devuelve el id de grupo de un agente.

Sintaxis de la llamada:

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

Ejemplo

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

= 5.1

devuelve el nombre de grupo de un agente.

Sintaxis de la llamada:

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

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

= 7.0NG

devuelve el nombre de grupo de un agente.

Sintaxis de la llamada:

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

Ejemplo

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

= 7.0NG

devuelve el id de grupo a partir del nombre.

Sintaxis de la llamada:

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

Ejemplo

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

= 7.0NG

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

Sintaxis de la llamada:

• op=get
• op2=timezone

Ejemplo

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

= 7.0

Obtener estado del cluster a partir del id

• op=get
• op2=cluster_status
• id=id del cluster

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

= 7.0

Obtener id de cluster a partir del nombre

• op=get
• op2=cluster_id_by_name
• id=nombre del cluster

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

= 7.0

Obtener los id ⇒ nombres de los agentes del cluster a partir del id de cluster

• op=get
• op2=agents_id_name_by_cluster_id
• id=id del cluster

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

= 7.0

Obtener los id ⇒ nombres de los agentes del cluster a partir del nombre de cluster

• op=get
• op2=agents_id_name_by_cluster_name
• id=id del cluster

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

= 7.0

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

• op=get
• op2=modules_id_name_by_cluster_id
• id=id del cluster

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

= 7.0

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

• op=get
• op2=modules_id_name_by_cluster_name
• id=id del cluster

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

= 7.0

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

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

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

• op=get
• op2=cluster_items
• id=id del cluster

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

= 7.0NG. 725

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

Sintaxis de la llamada:

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

Ejemplo

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

= 7.0NG. 725

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

Sintaxis de la llamada:

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

Ejemplo

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

= 7.0NG. 725

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

Sintaxis de la llamada:

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

Ejemplo

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

= 7.0NG. 725

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

Sintaxis de la llamada:

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

Ejemplo

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

= 7.0NG. 725

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

Sintaxis de la llamada:

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

Ejemplo

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

= 7.0NG. 725

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

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

Sintaxis de la llamada:

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

Ejemplo

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

= 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 mostrarán las acciones de las alertas de dicha política, si no 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

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

= 7.0NG. 725

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

Sintaxis de la llamada:

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

Ejemplo

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

= 7.0NG. 725

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

Sintaxis de la llamada:

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

Ejemplo

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

= 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

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

= 7.0NG. 728

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

Sintaxis de la llamada:

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

Ejemplo

https://localhost/pandora_console/include/api.php?op=get&op2=traps&other=1537128000|9000|0|1|.1.2.3.6.4&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

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

Sintaxis de la llamada:

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

Ejemplo

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

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

Devuelve la lista de los usuario de Pandora FMS.

Sintaxis de la llamada:

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

Ejemplo

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

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

Listar todos los usuarios de Pandora FMS

Sintaxis de la llamada:

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

Ejemplo

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

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

Lista la informacion de un usuario

Sintaxis de la llamada:

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

Ejemplo

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

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

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

Sintaxis de la llamada:

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

Ejemplo

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

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

Solamente para Command Center -Metaconsola-.

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

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

Ejemplo

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

= 7.0NG 730

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

Sintaxis de la llamada:

• op=get
• op2=language

Ejemplo

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

= 7.0NG 730

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

Sintaxis de la llamada:

• op=get
• op2=session_timeout

Ejemplo

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

devuelve los grupos existentes.

Sintaxis de la llamada:

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

Ejemplo

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

Obtener grupos de usuario mediante filtrado.

Sintaxis de la llamada:

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

Ejemplo

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

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

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

Sintaxis de la llamada:

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

Ejemplos

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

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

Lista los módulos de inventario de un agente utilizando nombre de agente.

Sintaxis de la llamada:

• op=get (obligatorio)
• op2=inventory_modules_by_name (obligatorio)
• id=<nombre de agente> (obligatorio)

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

Lista los módulos de inventario de un agente utilizando alias de agente.

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

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

Devuelve la lista de todas las colecciones en Pandora FMS en formato JSON.

Sintaxis de la llamada:

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

Ejemplos

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

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

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.

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

Obtiene los ID de los eventos de el Command Center (Metaconsola), utilizando el id del nodo y el id del evento del nodo.

Sintaxis de la llamada:

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

Ejemplo

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

Devuelve si un nodo está centralizado ( 1 ) o no ( 0 ). En caso de no existir el nodo devolverá una cadena de texto informando de ello. Puede utilizarse en el Command Center (Metaconsola) o directamente en el nodo.

Sintaxis de la llamada:

• op=get (obligatorio).
• op2=is_centralized (obligatorio).
• id=(obligatorio en el Command Center -Metaconsola-, innecesario en el nodo).

Ejemplo nodo:

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

Ejemplo en el Command Center (Metaconsola):

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

Envia los datos.

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

Sintaxis de la llamada:

• op=set (obligatorio).
• op2=new_agent (obligatorio).
• id= En Command Center (Metaconsola), identificador numérico del nodo al cual pertenecerá el agente (obligatorio).
• other=<parámetros serializados> (obligatorio) son la configuración y datos del agente, serializados en el siguiente orden:
  • <alias_agente>
  • <dir_ip>
  • <id_padre>
  • <id_grupo>
  • <protección_cascada>
  • <protección_cascada_módulo>
  • <intervalo_segundos>
  • <id_os>
  • <nombre_servidor>
  • <id_personalizado>
  • <modo_aprendizaje>
  • <deshabilitado>
  • <descripción>
  • <nombre_como_alias>

Ejemplos

Llamada de ejemplo para nodo (vea sintaxis de la llamada):

.../include/api.php?op=set&op2=new_agent&other=agent_api|1.1.1.1|0|4|0|0|300|10|pandorafms|8|10||description|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Llamada de ejemplo para el Command Center (Metaconsola) (vea sintaxis de la llamada):

.../include/api.php?op=set&op2=new_agent&id=1&other=agent_api|1.1.1.1|0|4|0|0|300|10|pandorafms|8|10||description|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

• Nota: Si <nombre_como_alias> es un 1, el nombre del agente será igual al alias. Si es un 0, el nombre del agente se generará automáticamente.

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

Sintaxis de la llamada:

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

Ejemplo (vea sintaxis de la llamada):

.../include/api.php?op=set&op2=update_agent&id=5&other=agente_nombre|1.1.1.1|0|4|0|0|30|8|localhost.localdomain||0|0|description|Ubuntu&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Esta llamada actualiza el o los campos de uno o varios Agentes (esto último si utiliza alias y existen varios que coincidan con ello.

Sintaxis de la llamada:

• op=set (obligatorio)
• op2=update_agent_field (obligatorio)
• id=<id_agente> o <alias> (obligatorio), dependiendo <alias> del parámetro id2.
• id2= <0> si es <id_agente> (opcional), <1> si es <alias> (obligatorio).
• other=<parámetros serializados> (obligatorio) son la configuración y datos del agente, serializados en el siguiente orden:
  • <alias_agente> (opcional)
  • <direccion> (opcional)
  • <id_parent> (opcional)
  • <id_grupo> (opcional)
  • <cascade_protection> (opcional)
  • <cascade_protection_module> (opcional)
  • <intervalo> (opcional)
  • <id_os> (opcional)
  • <server_name> (opcional)
  • <custom_id> (opcional)
  • <modo> (opcional)
  • <disabled> (opcional)
  • <comentarios> (opcional)

Ejemplos

En caso de utilizar el identificador del Agente:

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_agent_field&id=1&other=id_os,1|alias,pandora|direccion,192.168.10.16|id_parent,1cascade_protection,1|cascade_protection_module,1|intervalo,5||modo|3|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

En caso de utilizar alias, modifica todos los agentes que contengan ese alias:

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=update_agent_field&id=pandora&id2=1&other=id_os,1|alias,pandora|direccion,192.168.10.16|id_parent,1cascade_protection,1|cascade_protection_module,1|intervalo,5||modo|3|&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Elimina un agente pasando el nombre como parámetro.

Sintaxis de la llamada:

• op=set (obligatorio)
• op2=delete_agent (obligatorio)
• id=<nombre_agente> (obligatorio) debe ser un nombre agente.
• other=<use_agent_alias> (opcional) acepta valores 0 y 1.

Ejemplos

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

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

Sintaxis de llamada:

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

Ejemplos

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

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

Estas plantillas de módulos son una agrupación que contiene módulos de comprobación de red. Estas plantillas pueden ser aplicadas directamente a agentes, evitando tener que añadir módulos uno a uno.

Sintaxis de la llamada:

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

Ejemplos

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

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

Sintaxis de la llamada:

• op=set (obligatorio).
• op2=create_network_module (obligatorio).
• id= < nombre_agente > (obligatorio) debe ser un nombre agente.
• other= < parámetros serializados > (obligatorios) son la configuración y datos del modulo, serializados en el siguiente orden:

1. < name_module >
2. < disabled >
3. < id_module_type >
4. < id_module_group >
5. < min_warning >
6. < max_warning >
7. < str_warning >
8. < min_critical >
9. < max_critical >
10. < str_critical >
11. < ff_threshold >
12. < history_data >
13. < ip_target >
14. < tcp_port >
15. < snmp_community >
16. < snmp_oid >
17. < module_interval >
18. < post_process >
19. < min_value >
20. < max_value >
21. < custom_id >
22. < description >
23. < enable_unknown_events >
24. < module_macros > 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>”.
25. < each_ff >
26. < ff_threshold_normal >
27. < ff_threshold_warning >
28. < ff_threshold_critical >
29. < critical_inverse >
30. < warning_inverse >
31. < ff_type >
32. < ignore_unknown > Acepta valores 0 y 1.
33. < number_of_intervals_in_warning > Permite el escalado de estados especificando el máximo número de intervalos seguidos en los cuales el módulo permanece en estado de advertencia. Al superar este valor el módulo escalará a estado crítico.

Ejemplo (vea sintaxis de la llamada):

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

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

Sintaxis de la llamada:

• op=set (obligatorio).
• op2=create_plugin_module (obligatorio).
• id= < nombre_agente > (obligatorio) debe ser un nombre agente.
• other= < parámetros serializados > (obligatorios) son la configuración y datos del módulo, serializados en el siguiente orden:

1. < name_module >
2. < disabled >
3. < id_module_type >
4. < id_module_group >
5. < min_warning >
6. < max_warning >
7. < str_warning >
8. < min_critical >
9. < max_critical >
10. < str_critical >
11. < ff_threshold >
12. < history_data >
13. < ip_target >
14. < tcp_port >
15. < snmp_community >
16. < snmp_oid >
17. < module_interval >
18. < post_process >
19. < min_value >
20. < max_value >
21. < custom_id >
22. < description >
23. < id_plugin >
24. < plugin_user >
25. < plugin_pass >
26. < plugin_parameter >
27. < enable_unknown_events >
28. < macros > Los valores deben estar en formato JSON codificado en base 64.
29. < module_macros > 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>” (véase ejemplo al final de esta sección).
30. < each_ff >
31. < ff_threshold_normal >
32. < ff_threshold_warning >
33. < ff_threshold_critical >
34. < critical_inverse >
35. < warning_inverse >
36. < ff_type >
37. < use_agent_alias > Acepta valores 0 y 1.
38. < ignore_unknown > Acepta valores 0 y 1.
39. < number_of_intervals_in_warning > Permite el escalado de estados especificando el máximo número de intervalos seguidos en los cuales el módulo permanece en estado de advertencia. Al superar este valor el módulo escalará a estado crítico.

Ejemplo (vea sintaxis de la llamada):

Ejemplo sin macro alguno:

…/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||||||||||||2001&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

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 de formato de macro JSON:

{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1",
   "hide": ""
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80",
   "hide": ""
 }
}

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

Sintaxis de la llamada:

• op=get (obligatorio).
• op2=create_data_module (obligatorio).
• id=< nombre_agente > (obligatorio) debe ser un nombre agente.
• other=< parámetros serializados > (obligatorios) son la configuración y datos del módulo, serializados en el siguiente orden:

1. < name_module >
2. < disabled >
3. < id_module_type >
4. < description >
5. < id_module_group >
6. < min_value >
7. < max_value >
8. < post_process >
9. < module_interval >
10. < min_warning >
11. < max_warning >
12. < str_warning >
13. < min_critical >
14. < max_critical >
15. < str_critical >
16. < history_data >
17. < enable_unknown_events >
18. < module_macros > 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 >”.
19. < ff_threshold >
20. < each_ff >
21. < ff_threshold_normal >
22. < ff_threshold_warning >
23. < ff_threshold_critical >
24. < ff_timeout >
25. < critical_inverse >
26. < warning_inverse >
27. < ff_type >
28. < ignore_unknown > Acepta valores 0 y 1.
29. < number_of_intervals_in_warning > Permite el escalado de estados especificando el máximo número de intervalos seguidos en los cuales el módulo permanece en estado de advertencia. Al superar este valor el módulo escalará a estado crítico.

Ejemplo (vea sintaxis de la llamada), se debe tener creado previamente un agente con el nombre test:

…/include/api.php?op=set&op2=create_data_module&id=test&other=test2|0|1|data%20module%20from%20api|1|10|20|10.50|180|10|15||16|20||0|||||||||||||2001&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Crea un módulo SNMP.

Sintaxis de la llamada:

• op=set (obligatorio).
• op2=create_snmp_module (obligatorio)
• id= < nombre_agente > (obligatorio) debe ser un nombre agente.
• other= < parámetros serializados > (obligatorio) son la configuración y datos del módulo, serializados en el siguiente orden:

1. < name_module >
2. < disabled >
3. < id_module_type >
4. < id_module_group >
5. < min_warning >
6. < max_warning >
7. < str_warning >
8. < min_critical >
9. < max_critical >
10. < str_critical >
11. < ff_threshold >
12. < history_data >
13. < ip_target >
14. < module_port >
15. < snmp_version >
16. < snmp_community >
17. < snmp_oid >
18. < module_interval >
19. < post_process >
20. < min_value >
21. < max_value >
22. < custom_id >
23. < description >
24. < snmp3_priv_method [AES|DES] >
25. < snmp3_priv_pass >
26. < snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv] >
27. < snmp3_auth_method [MD5|SHA] >
28. < snmp3_auth_user >
29. < snmp3_auth_pass >
30. < enable_unknown_events >
31. < each_ff >
32. < ff_threshold_normal >
33. < ff_threshold_warning >
34. < ff_threshold_critical >
35. < ff_type >
36. < ignore_unknown > Acepta valores 0 y 1.
37. < number_of_intervals_in_warning > Permite el escalado de estados especificando el máximo número de intervalos seguidos en los cuales el módulo permanece en estado de advertencia. Al superar este valor el módulo escalará a estado crítico.

Ejemplo (vea sintaxis de la llamada):

Primer ejemplo (snmp v: 1):

…/include/api.php?op=set&op2=create_snmp_module&id=example&other=test5|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%20module%20from%20API||||||||2001&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Segundo ejemplo (snmp v: 3, snmp3_priv_method: AES, snmp3_priv_pass: example_priv_passw, snmp3_sec_level: authNoPriv, snmp3_auth_method:MD5, snmp3_auth_user: example_user, snmp3_auth_pass: example_priv_passw):

…/include/api.php?op=set&op2=create_snmp_module&id=example&other=test7|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|example_user|example_auth_passw|||||||||2001&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

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

Sintaxis de la llamada:

• op=get (obligatorio).
• op2=update_network_module (obligatorio).
• id=< id_modulo > (obligatorio) debe ser el ID numérico del módulo (tagente_modulo).
• other=< parámetros serializados > (obligatorios) son la configuración y datos del modulo, serializados en el siguiente orden:

1. < id_agent >
2. < disabled >
3. < id_module_group >
4. < min_warning >
5. < max_warning >
6. < str_warning >
7. < min_critical >
8. < max_critical >
9. < str_critical >
10. < min_ff_even >
11. < ff_threshold >
12. < history_data >
13. < ip_target >
14. < tcp_port >
15. < snmp_community >
16. < snmp_oid >
17. < module_interval >
18. < post_process >
19. < min_value >
20. < max_value >
21. < custom_id >
22. < description >
23. < disabled_types_event >
24. < module_macros > 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 >”.
25. < each_ff >
26. < ff_threshold_normal >
27. < ff_threshold_warning >
28. < ff_threshold_critical >
29. < critical_inverse >
30. < warning_inverse >
31. < ff_type >
32. < number_of_intervals_in_warning > Permite el escalado de estados especificando el máximo número de intervalos seguidos en los cuales el módulo permanece en estado de advertencia. Al superar este valor el módulo escalará a estado crítico.

Ejemplo (vea sintaxis de la llamada):

…/include/api.php?op=set&op2=update_network_module&id=132&other=|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|||||||||||2020&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

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

Sintaxis de la llamada:

• op=set (obligatorio).
• op2=update_plugin_module (obligatorio).
• id=< nombre_modulo > (obligatorio) debe ser el identificador numérico del módulo a actualizar (tagente_modulo).
• other= < parámetros serializados > (obligatorios) son la configuración y datos del módulo, serializados en el siguiente orden:

1. < id_agent >
2. < disabled >
3. < id_module_group >
4. < min_warning >
5. < max_warning >
6. < str_warning >
7. < min_critical >
8. < max_critical >
9. < str_critical >
10. < ff_threshold >
11. < history_data >
12. < ip_target >
13. < tcp_port >
14. < snmp_community >
15. < snmp_oid >
16. < module_interval >
17. < post_process >
18. < min_value >
19. < max_value >
20. < custom_id >
21. < description >
22. < id_plugin >
23. < plugin_user >
24. < plugin_pass >
25. < plugin_parameter >
26. < disabled_types_event >
27. < macros > Los valores deben estar en formato JSON codificado en base 64.
28. < module_macros > 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>”. Véase ejemplo al final de esta sección.
29. < each_ff >
30. < ff_threshold_normal >
31. < ff_threshold_warning >
32. < ff_threshold_critical >
33. < critical_inverse>
34. < warning_inverse>
35. < policy_linked >
36. < ff_type >
37. < ignore_unknown > Acepta valores 0 y 1.
38. < number_of_intervals_in_warning > Permite el escalado de estados especificando el máximo número de intervalos seguidos en los cuales el módulo permanece en estado de advertencia. Al superar este valor el módulo escalará a estado crítico.

Ejemplo (vea sintaxis de la llamada):

…/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|pluginmodule%20from%20api|2|admin|pass|-p%20max&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

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 de formato de macro JSON:

{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1"
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80"
 }
}

Otro ejemplo con escalado de estados:

…/include/api.php?op=set&op2=update_plugin_module&id=135&other=|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|||||||||||||2020&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Actualiza un módulo local.

Sintaxis de la llamada:

• op=set (obligatorio).
• op2=update_data_module (obligatorio).
• id=< id_módulo_agente > (obligatorio) el identificador numérico del módulo a actualizar.
• other=< parámetros serializados > (obligatorio) son la configuración y datos del módulo, serializados en el siguiente orden:

1. < id_agente >
2. < deshabilitado > utilice 1 para deshabilitar, 0 sin cambios.
3. < descripción >
4. < id_modulo_grupo > véase get_module_groups.
5. < valor_mín >
6. < valor_máx >
7. < post_proceso > ( Solamente para Agentes Software con configuración remota habilitada).
8. < intervalo_módulo >
9. < advertencia_valor_mín >
10. < advertencia_valor_máx >
11. < advertencia_valor_cadena >
12. < crítico_valor_mín >
13. < crítico_valor_máx >
14. < crítico_valor_cadena >
15. < historial_datos > Si está a 0 no se guardan datos del Módulo en la tabla tagente_datos, únicamente se actualiza la tabla tagente_estado.
16. < deshabilitar_tipos_de_eventos > En formato JSON, por ejemplo: {“going_unknown”:1} .
17. < macros_de_módulo > En formato JSON codificado en base 64. El formato de los datos del documento JSON debe ser “<nombre de macro>”: “<valor de macro>”.
18. < mín_flipflop_eventos > Número de veces que tiene que darse una condición de cambio de estado antes de que dicho cambio tenga lugar (flipflop ).
19. < cada_flipflop>
20. < mín_flipflop_evento_normal >
21. < mín_flipflop_evento_advertencia >
22. < mín_flipflop_evento_crítico >
23. < tiempo_de _espera_flipflop >
24. < tomar_valor_inverso_crítico >
25. < tomar_valor_inverso_advertencia >
26. < enlazado_política >
27. < tipo_flipflop >
28. < ignore_unknown > Acepta valores 0 y 1.

Ejemplo (vea sintaxis de la llamada):

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

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

Sintaxis de la llamada:

• op=set (obligatorio).
• op2=update_data_module_policy (obligatorio).
• id=< id_policy > (obligatorio) El identificador numérico de la política a modificar.
• other=< parámetros serializados > (obligatorio) son la configuración y datos del módulo, serializados en el siguiente orden:

1. < id_policy_module > : Identificador numérico del módulo de la política.
2. < description > : Descripción.
3. < id_module_group > : Identificador del grupo del módulo.
4. < min > : Mínimo valor.
5. < max > : Máximo valor.
6. < post_process > : Post procesado.
7. < module_interval > : Intervalo del módulo.
8. < min_warning > : Valor mínimo de advertencia.
9. < max_warning > : Valor máximo de advertencia.
10. < min_critical > : Valor mínimo de criticidad.
11. < max_critical > : Valor máximo de criticidad.
12. < str_critical > : Cadena de caracteres de criticidad.
13. < history_data > : Datos históricos.
14. < configuration_data > : Datos de configuración.
15. < disabled_types_event > : Tipos de evento deshabilitados.
16. < module_macros > Los valores deben estar en formato JSON codificado en base 64. El formato de los datos del documento JSON debe ser: < macro name > : < macro value > .
17. < ignore_unknown > (Acepta valores 0 y 1).

Ejemplo (vea sintaxis de la llamada):

.../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
module_name pandora_process
module_type generic_data
module_exec ps aux | grep pandora | wc -l
module_end&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Actualiza un módulo SNMP.

Sintaxis de la llamada:

• op=set (obligatorio).
• op2=update_snmp_module (obligatorio).
• id= < id_module > (obligatorio) debe ser un identificador numérico de módulo.
• other= < parámetros serializados > (obligatorios) son la configuración y datos del módulo, serializados en el siguiente orden:

1. < id_agent >
2. < disabled >
3. < id_module_group >
4. < min_warning >
5. < max_warning >
6. < str_warning >
7. < min_critical >
8. < max_critical >
9. < str_critical >
10. < ff_threshold >
11. < history_data >
12. < ip_target >
13. < module_port >
14. < snmp_version >
15. < snmp_community >
16. < snmp_oid >
17. < module_interval >
18. < post_process >
19. < min_value >
20. < max_value >
21. < custom_id >
22. < description >
23. < snmp3_priv_method [AES|DES] >
24. < snmp3_priv_pass >
25. < snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv] >
26. < snmp3_auth_method [MD5|SHA] >
27. < snmp3_auth_user >
28. < snmp3_auth_pass >
29. < disabled_types_event >
30. < each_ff >
31. < ff_threshold_normal >
32. < ff_threshold_warning >
33. < ff_threshold_critical>
34. < policy_linked >
35. < ff_type >
36. < ignore_unknown > Acepta valores 0 y 1.
37. < number_of_intervals_in_warning > Permite el escalado de estados especificando el máximo número de intervalos seguidos en los cuales el módulo permanece en estado de advertencia. Al superar este valor el módulo escalará a estado crítico.

Ejemplo (vea sintaxis de la llamada):

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

…/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

Otro ejemplo con escalado de estados y SNMP v1:

…/include/api.php?op=set&op2=update_snmp_module&id=137&other=|0|6|20|25||26|30||15|1|127.0.0.1|60|1|public|.1.3.6.1.2.1.1.1.0|180|50.00|10|60|||||||||||2020&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

Otro ejemplo con escalado de estados y SNMP v3:

…/include/api.php?op=set&op2=update_snmp_module&id=138&other=|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|||||||||2020&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

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

Sintaxis de la llamada:

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

Ejemplos

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

Aplica todas las políticas que contiene Pandora.

Sintaxis de la llamada:

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

Ejemplos

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

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

Sintaxis de la llamada:

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

1. < name_module >
2. < id_module_type >
3. < description >
4. < id_module_group >
5. < min_value >
6. < max_value >
7. < post_process >
8. < module_interval >
9. < min_warning >
10. < max_warning >
11. < str_warning >
12. < min_critical >
13. < max_critical >
14. < str_critical >
15. < history_data >
16. < ff_threshold >
17. < disabled >
18. < module_port >
19. < snmp_community >
20. < snmp_oid >
21. < custom_id >
22. < enable_unknown_events >
23. < module_macros > 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 >”.
24. < each_ff >
25. < ff_threshold_normal >
26. < ff_threshold_warning >
27. < ff_threshold_critical >
28. < ff_type >
29. < ignore_unknown > Acepta valores 0 y 1.

Ejemplo (véase sintaxis de la llamada):

…/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

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

Sintaxis de la llamada:

• op=set (obligatorio).
• op2=add_plugin_module_policy (obligatorio).
• id= < id_politica > (obligatorio) debe ser un identificador de política.
• other= < parámetros serializados > (obligatorios) son la configuración y datos del módulo, serializados en el siguiente orden:

1. < name_module >
2. < disabled >
3. < id_module_type >
4. < id_module_group >
5. < min_warning >
6. < max_warning >
7. < str_warning >
8. < min_critical >
9. < max_critical >
10. < str_critical >
11. < ff_threshold >
12. < history_data >
13. < module_port >
14. < snmp_community >
15. < snmp_oid >
16. < module_interval >
17. < post_process >
18. < min_value >
19. < max_value >
20. < custom_id >
21. < description >
22. < id_plugin >
23. < plugin_user >
24. < plugin_pass >
25. < plugin_parameter >
26. < enable_unknown_events >
27. < macros > Los valores deben estar en formato JSON codificado en base 64. Véase ejemplo al final de esta sección.
28. < module_macros > 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 >”.
29. < each_ff >
30. < ff_threshold_normal >
31. < ff_threshold_warning >
32. < ff_threshold_critical >
33. < ff_type >
34. < ignore_unknown > Acepta valores 0 y 1.

Ejemplo (vea sintaxis de la llamada):

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

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 de macro:

{
 "1": {
   "macro": "_field1_",
   "desc": "Target IP",
   "help": "",
   "value": "192.168.0.1"
 },
 "2": {
   "macro": "_field2_",
   "desc": "Port",
   "help": "",
   "value": "80"
 }
}

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

Sintaxis de la llamada:

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

Ejemplos

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

Actualiza un módulo de plugin en la política pasada por identificador en el parámetro.

Sintaxis de la llamada:

• op=set (obligatorio).
• op2=update_plugin_module_policy (obligatorio).
• id= < id_politica > (obligatorio) debe ser un identificador de política.
• other= < parámetros serializados > (obligatorios) son la configuración y datos del módulo, serializados en el siguiente orden:

1. < id_policy_module >
2. < disabled >
3. < id_module_group >
4. < min_warning >
5. < max_warning >
6. < str_warning >
7. < min_critical >
8. < max_critical >
9. < str_critical >
10. < ff_threshold >
11. < history_data >
12. < module_port >
13. < snmp_community >
14. < snmp_oid >
15. < module_interval >
16. < post_process >
17. < min_value >
18. < max_value >
19. < custom_id >
20. < description >
21. < id_plugin >
22. < plugin_user >
23. < plugin_pass >
24. < plugin_parameter >
25. < disabled_types_event >
26. < macros > Los valores deben estar en formato JSON codificado en base 64. Véase ejemplo al final de esta sección.
27. < module_macros > 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 >”.
28. < ignore_unknown > Acepta valores 0 y 1.

Ejemplo (vea sintaxis de la llamada):

…/include/api.php?op=set&op2=update_plugin_module_policy&id=1&other=23|0|1|0|0||0|0||15|0|166|||180|150.00|0|0|0|plugin%20module%20updated%20from%20api|2|example_user|pass|-p%20min&other_mode=url_encode_separator_|

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.

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

Sintaxis de la llamada:

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

1. < name_module >
2. < disabled >
3. < id_module_type >
4. < id_module_group >
5. < min_warning >
6. < max_warning >
7. < str_warning >
8. < min_critical >
9. < max_critical >
10. < str_critical >
11. < ff_threshold >
12. < history_data >
13. < module_port >
14. < snmp_version >
15. < snmp_community >
16. < snmp_oid >
17. < module_interval >
18. < post_process >
19. < min_value >
20. < max_value >
21. < custom_id >
22. < description >
23. < snmp3_priv_method [AES|DES] >
24. < snmp3_priv_pass >
25. < snmp3_sec_level [authNoPriv|authPriv|noAuthNoPriv] >
26. < snmp3_auth_method [MD5|SHA] >
27. < snmp3_auth_user >
28. < snmp3_auth_pass >
29. < enable_unknown_events >
30. < each_ff >
31. < ff_threshold_normal >
32. < ff_threshold_warning >
33. < ff_threshold_critical >
34. < ff_type >
35. < ignore_unknown > Acepta valores 0 y 1.

Ejemplo (vea sintaxis de la llamada):

…/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 module modified by API|AES|example_priv_passw|authNoPriv|MD5|example_user|example_auth_passw&other_mode=url_encode_separator_|&apipass=1234&user=admin&pass=pandora

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

Sintaxis de la llamada:

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

Ejemplos

• Nodo:

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

• Command Center (Metaconsola):

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

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

Sintaxis de la llamada:

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

Ejemplos

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

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

Sintaxis de la llamada:

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

Ejemplos

• Nodo:

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

• Command Center (Metaconsola):

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

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

Sintaxis de la llamada:

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

Ejemplos

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

Crea un nuevo componente de red.

Sintaxis de la llamada:

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

Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_network_component&id=example_network_component_name&other=7|network component created by Api|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

Crea un nuevo componente de plugin.

Sintaxis de la llamada:

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

Ejemplos

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

Crea un nuevo componente de SNMP.

Sintaxis de la llamada:

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

Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_snmp_component&id=example_snmp_component_name&other=16|SNMP component created by Api|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

Crea un nuevo componente local.

Sintaxis de la llamada:

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

Ejemplos

http://127.0.0.1/pandora_console/include/api.php?op=set&op2=new_local_component&id=example_local_component_name&other=local component created by Api~5~12~module_begin
module_name example_local_component_name
module_type generic_data
module_exec ps | grep pid | wc -l
module_interval 2
module_end&other_mode=url_encode_separator_~&apipass=1234&user=admin&pass=pandora

Crea una plantilla de alerta.

Sintaxis de la llamada:

• op=set (obligatorio)
• op2=create_alert_template (obligatorio)
• id=<template_name> (obligatorio) el nombre de la plantilla.
• other=<serialized parameters> (obligatorio) las configuraciones y datos de la plantilla, serializados en el siguiente orden:
  • <type [regex|max_min|max|min|equal|not_equal|warning|critical|onchange|unknown|always|not_normal]>
  • <description>
  • <id_alert_action>
  • <field1>
  • <field2>
  • <field3>
  • <value>
  • <matches_value>
  • <max_value>
  • <min_value>
  • <time_threshold>
  • <max_alerts>
  • <min_alerts>
  • <time_from>
  • <time_to>
  • <monday>
  • <tuesday>
  • <wednesday>
  • <thursday>
  • <friday>
  • <saturday>
  • <sunday>
  • <recovery_notify>
  • <field2_recovery>
  • <field3_recovery>
  • <priority>
  • <id_group>
  • <special_day>
  • <min_alerts_reset_counter>
  • <field1_recovery>
  • <field4>
  • <field5>
  • <field6>
  • <field7>
  • <field8>
  • <field9>
  • <field10>
  • <field11>
  • <field12>
  • <field13>
  • <field14>
  • <field15>
  • <field4_recovery>
  • <field5_recovery>
  • <field6_recovery>
  • <field7_recovery>
  • <field8_recovery>
  • <field9_recovery>
  • <field10_recovery>
  • <field11_recovery>
  • <field12_recovery>
  • <field13_recovery>
  • <field14_recovery>
  • <field15_recovery>