Task-Objekt

Die folgenden Objekte stehen in direktem Zusammenhang mit der task-API.

Task

Das Task-Objekt hat die folgenden Eigenschaften:

Property Type Description
taskid ID ID des Tasks.

Property behavior:
- read-only
type integer Typ des Tasks.

Mögliche Werte:
1 - Diagnoseinformationen;
2 - Proxy-Konfiguration aktualisieren;
6 - Jetzt ausführen.

Seit Zabbix 7.0.19 können Benutzer vom Typ Admin und User Tasks vom Typ 'Execute now' erstellen.

Beachten Sie, dass task.get immer "7" zurückgibt (Task execution summary).

Property behavior:
- required
status integer Status des Tasks.

Mögliche Werte:
1 - neuer Task;
2 - Task in Bearbeitung;
3 - Task ist abgeschlossen;
4 - Task ist abgelaufen.

Property behavior:
- read-only
clock timestamp Zeitpunkt, zu dem der Task erstellt wurde.

Property behavior:
- read-only
ttl integer Zeit in Sekunden, nach der der Task abläuft.

Property behavior:
- read-only
proxyid ID ID des Proxy, über den Diagnoseinformationen erfasst werden.

Property behavior:
- supported wenn type auf "Diagnostic information" oder "Refresh proxy configuration" gesetzt ist
request object Task-Anfrageobjekt entsprechend dem Task-Typ:
Objekt des Tasks 'Execute now' ist unten ausführlich beschrieben;
Objekt des Tasks 'Refresh proxy configuration' ist unten ausführlich beschrieben;
Objekt des Tasks 'Diagnostic information' ist unten ausführlich beschrieben.

Property behavior:
- required
result object Ergebnisobjekt des Tasks für Diagnoseinformationen.
Kann NULL enthalten, wenn das Ergebnis noch nicht bereit ist.
Das Ergebnisobjekt ist unten ausführlich beschrieben.

Property behavior:
- read-only

Objekt der Anfrage 'Execute now'

Das Anfrageobjekt für die Aufgabe 'Execute now' hat die folgenden Eigenschaften.

Property Type Description
itemid ID ID des Datenpunkts und der Regeln für Low-Level-Discovery.

Seit Zabbix 7.0.19 können Benutzer vom Typ Admin und User Datenpunkte auf Hosts mit der Berechtigung read-write permission oder mit read Berechtigung und aktivierter action invoke_execute_now für ihre Rolle mit 'Execute now' ausführen. Dasselbe gilt für Benutzer vom Typ Admin bei Regeln für Low-Level-Discovery (LLD).

Anforderungsobjekt „Refresh proxy configuration“

Das Anforderungsobjekt der Aufgabe „Refresh proxy configuration“ hat die folgenden Eigenschaften.

Eigenschaft Type Beschreibung
proxyids array Proxy-IDs.

Anfrageobjekt „Diagnoseinformationen“

Das Anfrageobjekt für die Aufgabe „Diagnoseinformationen“ hat die folgenden Eigenschaften. Das Statistik-Anfrageobjekt für alle Eigenschaftstypen wird weiter unten ausführlich beschrieben.

Eigenschaft Typ Beschreibung
historycache object Statistik-Anfrage für den Verlaufscache. Verfügbar auf Server und Proxy.
valuecache object Statistik-Anfrage für den Datenpunkt-Cache. Verfügbar auf Server.
preprocessing object Statistik-Anfrage für den Präprozessierungsmanager. Verfügbar auf Server und Proxy.
alerting object Statistik-Anfrage für den Alarmmanager. Verfügbar auf Server.
lld object Statistik-Anfrage für den LLD-Manager. Verfügbar auf Server.
Statistik-Anforderungsobjekt

Das Statistik-Anforderungsobjekt wird verwendet, um festzulegen, welche Art von Informationen über interne Prozesse von Server/Proxy gesammelt werden soll. Es hat die folgenden Eigenschaften.

Property Type Description
stats query Eigenschaften des Statistikobjekts, die zurückgegeben werden sollen.
Die Liste der verfügbaren Felder für jeden Typ von Statistik diagnostischer Informationen wird unten im Detail beschrieben.

Standard: extend gibt alle verfügbaren Statistikfelder zurück.
top object Objekt zum Sortieren und Begrenzen der zurückgegebenen Statistikwerte.
Die Liste der verfügbaren Felder für jeden Typ von Statistik diagnostischer Informationen wird unten im Detail beschrieben.

Beispiel: { "source.alerts": 10 }
Liste der Statistikfelder, die für jeden Typ von Diagnoseinformationsanfrage verfügbar sind

Die folgenden Statistikfelder können für jede Eigenschaft eines Typs von Diagnoseinformationsanfrage angefordert werden.

Diagnosetyp Verfügbare Felder Beschreibung
historycache items Anzahl der zwischengespeicherten Datenpunkte.
values Anzahl der zwischengespeicherten Werte.
memory Statistiken zum Shared Memory (freier Speicherplatz, Anzahl verwendeter Blöcke, Anzahl freier Blöcke, maximale Größe eines freien Blocks).
memory.data Shared-Memory-Statistiken des Verlaufsdatencaches.
memory.index Shared-Memory-Statistiken des Verlaufsindexcaches.
valuecache items Anzahl der zwischengespeicherten Datenpunkte.
values Anzahl der zwischengespeicherten Werte.
memory Statistiken zum Shared Memory (freier Speicherplatz, Anzahl verwendeter Blöcke, Anzahl freier Blöcke, maximale Größe eines freien Blocks).
mode Modus des Wertecaches.
preprocessing values Anzahl der Werte in der Warteschlange.
preproc.values Anzahl der Werte in der Warteschlange mit Vorverarbeitungsschritten.
alerting alerts Anzahl der Benachrichtigungen in der Warteschlange.
lld rules Anzahl der Regeln in der Warteschlange.
values Anzahl der Werte in der Warteschlange.
Liste der Sortierfelder, die für jeden Typ von Diagnoseinformationsanfrage verfügbar sind

Die folgenden Statistikfelder können verwendet werden, um angeforderte Informationen zu sortieren und zu begrenzen.

Diagnosetyp Verfügbare Felder Typ
historycache values integer
valuecache values integer
request.values integer
preprocessing values integer
alerting media.alerts integer
source.alerts integer
lld values integer
Statistik-Ergebnisobjekt

Das Statistik-Ergebnisobjekt wird im Feld result des task-Objekts abgerufen.

Eigenschaft Type Beschreibung
status integer Status des task-Ergebnisses.

Mögliche Werte:
-1 - während der Ausführung des task ist ein Fehler aufgetreten;
0 - das task-Ergebnis wurde erstellt.

Property behavior:
- read-only
data string/object Ergebnisse entsprechend dem Statistik-Anfrageobjekt der jeweiligen Diagnoseinformationstask.
Enthält eine Fehlerzeichenfolge, wenn während der Ausführung des task ein Fehler aufgetreten ist.