 |
This is a machine translation based on the English version of the article. It might or might not have already been subject to text preparation. If you find errors, please file a GitHub issue that states the paragraph that has to be improved. |
1. Introducción
Checkmk ofrece ahora toda una serie de interfaces diversas, sobre todo la API-REST, con la que puedes hacer gran parte de lo que también es posible a través de la interfaz web. Sin embargo, también hay APIs para los plugins de check, el inventario de hardware/software, el Agent bakery, etc. Hay artículos, referencias y otros recursos para todas estas interfaces, distribuidos por este Manual de usuario, el sitio web y el propio Checkmk.
En este artículo, proporcionaremos una Vista general de todas las interfaces y recursos y daremos algunos consejos sobre su manejo general. Muchos enlaces de este artículo son redundantes, ya que la información pretende servir para tres enfoques o preguntas diferentes:
¿Qué API proporciona Checkmk?
¿Qué artículos relevantes para la API se pueden encontrar en el Manual de usuario?
¿Qué recursos relacionados con la API están disponibles en Checkmk?
La interfaz más importante es, sin duda, la API-REST de Checkmk, con la que se puede hacer casi todo, desde el punto de vista de la programación, que también se puede realizar a través de la interfaz web.
 |
La GUI interactiva de la API-REST ofrece una introducción rápida y práctica a la API-REST. En ella puedes enviar y, opcionalmente, modificar consultas predefinidas. Puedes encontrar la GUI en el propio Checkmk a través de Help > Developer resources > REST API interactive GUI. |
La segunda interfaz principal son las API de plugins para desarrollar tus propias extensiones. Dependiendo de tu experiencia, puedes empezar aquí con nuestro artículo introductorio o con la referencia, que de nuevo puedes encontrar directamente en el propio Checkmk:Help > Developer resource > Plug-in API references.
En las tablas siguientes encontrarás estas API, pero también interfaces menos conocidas, como para el inventario de hardware/software, subinterfaces para el desarrollo de check plugins, como la API de gráficos explícitos, así como cuasi-interfaces, como el formato de salida de los local check, el precursor sencillo, basado en script, de los plugins completos.
2. API en Checkmk
| API | Manual de usuario | Web | Descripción |
|---|---|---|---|
API-REST |
Funcionalmente es un subconjunto de la interfaz web. |
||
API de Check |
Codificación de plugins de check. |
||
API de Panadería |
En Checkmk: |
Incluye check plugins en la Agent bakery. |
|
API de llamadas al servidor |
tbd |
En Checkmk: |
Desarrollar cheques activos y agentes especiales. |
API de gráficos |
Personalizar la visualización de métricas en el artículo del plugin de agente check plugin |
En Checkmk: |
Incluir métricas, gráficos, Perf-O-Meters. |
API de conjuntos de reglas |
Conjuntos de reglas para los parámetros de check en el artículo del plugin de agente check plugin |
En Checkmk: |
Desarrolla tus propios conjuntos de reglas. |
API DCD |
tbd |
En Checkmk: |
Conectores personalizados para el Daemon de Configuración Dinámica (DCD). |
API HW/SW |
n.d. |
API web para consultar datos de inventario. |
|
Livestatus |
Recuperación de datos de estado mediante Livestatus, referencia del comando Livestatus |
n.d. |
Recuperación directa de datos de estado mediante el Lenguaje de Consulta Livestatus (LQL). |
Interfaz de la Consola de eventos |
La interfaz deestado de la Consola de eventos |
n.d. |
Acceso al estado interno y ejecución de comandos mediante socket Unix. |
Local check |
n.d. |
"Mini interfaz" para tus propios checks basados en scripts. |
3. Artículos del Manual de usuario
| Área API | Manual de usuario | Descripción |
|---|---|---|
Automatización |
Descripción de la API-REST, así como de su documentación y posibles usos. |
|
Vista general de la interfaz de datos para información sobre host y servicios. |
||
Todas las tablas, cabeceras, filtros y operadores. |
||
Descripción de la web API propia del inventario para acceso externo. |
||
La interfaz deestado de la Consola de eventos |
Se pueden leer datos de la Consola de eventos y enviar comandos mediante un socket Unix y un subconjunto del protocolo Livestatus. |
|
Programación |
Vista general del artículo con todas las posibilidades de ampliación y enlaces a más información. |
|
Descripción detallada de cómo desarrollar un plugin de check. |
||
Descripción detallada del desarrollo de un check plugin para datos SNMP. |
4. Recursos en Checkmk
| En Checkmk | Descripción |
|---|---|
Help > Developer resources > Plug-in API references |
Una referencia basada en Sphinx de todas las API relevantes para el desarrollo de Plugin de Check. |
Help > Developer resources > REST API documentation |
Referencia basada en ReDoc/OpenAPI para todas las consultas relevantes para Check, incluidos ejemplos de código para Requests (Python), Urllib (Python), httpie y curl. |
Help > Developer resources > REST API interactive GUI |
Interfaz web interactiva para probar todos los endpoints de la API, incluyendo comentarios directamente en la página. |
Help > Developer resources > Plug-in API references > Agent based ("Check API") |
En la sección Version 2 > New in this version encontrarás información importante para la migración de Plugins antiguos a la versión actual de la API. |
5. Recursos en la web
| Recurso | Descripción |
|---|---|
Videotutorial (en inglés) con ejemplos prácticos para utilizar la API-REST, por ejemplo para establecer tiempos de mantenimiento programados. |
|
Ejemplos de Curl en la Base de Conocimientos de Checkmk para consultas concretas, por ejemplo, enlazadas AND. |
|
En la tienda de Plugin de Checkmk encontrarás muchas implementaciones prácticas de las API, incluido el código fuente. |