device.offboard

Mit dieser Methode können Sie mobile Geräte zur Verwendung mit der Zabbix Mobile App entfernen (Offboarding).

Die Methode ist für Benutzer mit den Rollen User, Admin und Super admin verfügbar, wenn EnableMobileDevices aktiviert ist und der Benutzer Zugriff auf Geräte hat. Der Zugriff auf API-Methoden kann in der Konfiguration der Benutzerrolle entzogen werden.

Benutzer mit den Rollen User und Admin können nur ihre eigenen Geräte entfernen.

Methodensignatur: object device.offboard(object parameters)

Methodenquelle: CDevice::offboard() in ui/include/classes/api/services/CDevice.php

Parameter

Parameter Typ Beschreibung
uuid string Universell eindeutiger Bezeichner des Geräts (UUIDv7). Entspricht deviceid.
force boolean Auf true setzen, um den Fehler „Gerät nicht gefunden“ zu ignorieren und das Gerät zwangsweise zu entfernen.

Standard: false

Rückgabewerte

Gibt ein Objekt zurück, das die UUID des entfernten Geräts enthält.

Beispiele

Gerät entfernen

Entfernt ein Gerät mit der angegebenen UUID und ignoriert den Fehler „Gerät nicht gefunden“.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "device.offboard",
    "params": {
        "uuid": "019d0106-5eef-7154-a159-bb29e35d38e5",
        "force": true
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": {
        "uuid": "019d0106-5eef-7154-a159-bb29e35d38e5"
    },
    "id": 1
}