 |
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. Introduzione
Checkmk offre ora una vasta gamma di interfacce diverse, prima fra tutte l'API REST, con la quale puoi fare gran parte di ciò che è possibile anche tramite l'interfaccia web. Tuttavia, esistono anche API per i plug-in di controllo, l'inventario HW/SW, l'Agent Bakery e così via. Ci sono articoli, riferimenti e altre risorse per tutte queste interfacce, distribuite in questa Guida per l'utente, sul sito web e all'interno dello stesso Checkmk.
In questo articolo forniremo una panoramica di tutte le interfacce e le risorse e daremo alcuni consigli sull'utilizzo generale. Molti link in questo articolo sono ridondanti, poiché le informazioni sono pensate per rispondere a tre diversi approcci o domande:
Quali API offre Checkmk?
Quali articoli relativi alle API si possono trovare nella Guida utente?
Quali risorse relative alle API sono disponibili in Checkmk?
L'interfaccia più importante è senza dubbio l'API REST di Checkmk, che può essere utilizzata per fare quasi tutto dal punto di vista della programmazione che può essere eseguito anche tramite l'interfaccia web.
 |
La GUI interattiva dell'API REST offre un'introduzione rapida e pratica all'API REST. Qui puoi inviare e, se vuoi, modificare query predefinite. Puoi trovare la GUI direttamente in Checkmk all'indirizzo Help > Developer resources > REST API interactive GUI. |
La seconda interfaccia principale è costituita dalle API dei plugin per lo sviluppo delle tue estensioni personalizzate. A seconda della tua esperienza, puoi iniziare da qui con il nostro articolo introduttivo o dalla guida di riferimento, che puoi trovare direttamente all’interno di Checkmk: Help > Developer resource > Plug-in API references.
|
Anche senza un sito Checkmk attivo, puoi visualizzare una copia della documentazione delle API dei plugin all'indirizzo docs.checkmk.com/plugin-api. |
Nelle tabelle sottostanti troverai queste API, ma anche interfacce meno conosciute, come quelle per l'inventario HW/SW, sotto-interfacce per lo sviluppo di plug-in di controllo, come l'API Graphing esplicita, nonché quasi-interfacce, come il formato di output dei controlli locali, il semplice precursore basato su script dei plug-in completi.
2. API in Checkmk
| API | Guida per l'utente | Web | Descrizione |
|---|---|---|---|
API REST |
Dal punto di vista funzionale, è un sottoinsieme dell'interfaccia web. |
||
API Check |
In Checkmk:Help > Developer resources > Plug-in API references > Agent based ("Check API")
, |
Programmazione di plug-in di controllo. |
|
API di inventario |
In Checkmk:Help > Developer resources > Plug-in API references > Agent based ("Check API") > Version 2
, |
Programmazione dei plugin di controllo. |
|
API Bakery |
In Checkmk: Help > Developer resources > Plug-in API references > Bakery, |
Includi i plug-in di controllo nell'Agent Bakery. |
|
API DCD |
In Checkmk: Help > Developer resources > Plug-in API references > Dynamic configuration connector, |
Connessioni personalizzate per la gestione dinamica degli host con il Dynamic Configuration Daemon (DCD). |
|
API per i grafici |
Personalizzazione della visualizzazione delle metriche nell'articolo sul plug-in di controllo basato su agente |
In Checkmk: Help > Developer resources > Plug-in API references > Graphing, |
Includi metriche, grafici, Perf-O-Meter. |
API dei set di regole |
Set di regole per i parametri di controllo nell'articolo sul plug-in di controllo basato su agente |
In Checkmk: Help > Developer resources > Plug-in API references > Rulesets, |
Sviluppa i tuoi set di regole. |
API delle chiamate lato server |
In Checkmk: Help > Developer resources > Plug-in API references > Server-side calls, |
Sviluppa controlli attivi e agenti speciali. |
|
API HW/SW |
n.d. |
API Web per interrogare i dati di inventario. |
|
Livestatus |
Recupero dei dati di stato tramite Livestatus, riferimento ai comandi Livestatus |
n.d. |
Recupero diretto dei dati di stato tramite Livestatus Query Language (LQL). |
Interfaccia della Console Eventi |
L'interfaccia di stato della Console eventi |
n.d. |
Accesso allo stato interno ed esecuzione di comandi tramite socket Unix. |
Controlli locali |
n.d. |
"Mini interfaccia" per i tuoi controlli basati su script. |
3. Articoli nella Guida per l'utente
| Area API | Guida utente | Descrizione |
|---|---|---|
Automazione |
Descrizione dell'API REST, della relativa documentazione e dei possibili utilizzi. |
|
Una panoramica dell'interfaccia dati per le informazioni su host e servizi. |
||
Tutte le tabelle, le intestazioni, i filtri e gli operatori. |
||
Descrizione dell'API web dell'inventario per l'accesso esterno. |
||
L'interfaccia di stato della Console Eventi |
È possibile leggere i dati dalla Console Eventi e inviare comandi tramite socket Unix e un sottoinsieme del protocollo Livestatus. |
|
Programmazione |
Articolo di panoramica con tutte le possibilità di estensioni e link a ulteriori informazioni. |
|
Descrizione dettagliata di come sviluppare un plug-in di controllo. |
||
Descrizione dettagliata dello sviluppo di un plug-in di controllo per dati SNMP. |
||
Descrizione dettagliata di come sviluppare un plug-in di inventario. |
4. Risorse in Checkmk
| In Checkmk | Descrizione |
|---|---|
Help > Developer resources > Plug-in API references |
Una guida basata su Sphinx di tutte le API rilevanti per lo sviluppo dei plugin di Check. |
Help > Developer resources > REST API documentation |
Riferimento basato su ReDoc/OpenAPI per tutte le query rilevanti per Check, inclusi esempi di codice per Requests (Python), Urllib (Python), httpie e curl. |
Help > Developer resources > REST API interactive GUI |
Interfaccia web interattiva per testare tutti gli endpoint API, con feedback direttamente sulla pagina. |
Help > Developer resources > Plug-in API references > Agent based ("Check API") |
Nella sezione "Version 2 > New in this version" troverai informazioni importanti per la migrazione dei vecchi plug-in alla versione attuale dell'API. |
5. Risorse sul web
| Risorsa | Descrizione |
|---|---|
Tutorial video (in inglese) con esempi pratici sull'uso dell'API REST, ad esempio per impostare i tempi di inattività programmati. |
|
Esempi Curl nella Knowledge Base di Checkmk per query concrete, ad esempio con collegamenti AND. |
|
Nel negozio di plug-in di Checkmk troverai molte implementazioni pratiche delle API, compreso il codice sorgente. |