REST Resource: customer.devices.chromeos.commands

Ressource: DirectoryChromeosdevicesCommand

Informationen zu einem Befehl, der für ein Gerät ausgegeben wurde.

JSON-Darstellung 
{
  "commandId": string,
  "type": enum (CommandType),
  "issueTime": string,
  "state": enum (State),
  "commandExpireTime": string,
  "commandResult": {
    object (DirectoryChromeosdevicesCommandResult)
  },
  "payload": string
}
Felder
commandId

string (int64 format)

Eindeutige ID eines Gerätebefehls.
type

enum (CommandType)

Der Typ des Befehls.
issueTime

string (Timestamp format)

Der Zeitstempel, zu dem der Befehl vom Administrator ausgegeben wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
state

enum (State)

Gibt den Befehlsstatus an.
commandExpireTime

string (Timestamp format)

Der Zeitpunkt, zu dem der Befehl abläuft. Wenn das Gerät den Befehl nicht innerhalb dieser Zeit ausführt, läuft er ab.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
commandResult

object (DirectoryChromeosdevicesCommandResult)

Das Ergebnis der Befehlsausführung.
payload

string

Die vom Befehl angegebene Nutzlast, falls vorhanden.

CommandType

Legt den Typ des Befehls fest, den das Gerät ausführen muss.

Enums
COMMAND_TYPE_UNSPECIFIED Der Befehlstyp wurde nicht angegeben.
REBOOT Starten Sie das Gerät neu. Kann für Kioskgeräte und Geräte mit verwalteten Gastsitzungen sowie für normale Geräte mit ChromeOS-Version 113 oder höher ausgegeben werden.
TAKE_A_SCREENSHOT Mache einen Screenshot des Geräts. Nur verfügbar, wenn sich das Gerät im Kioskmodus befindet.
SET_VOLUME Stellen Sie die Lautstärke des Geräts ein. Kann nur an Kiosk-Geräte und Geräte für verwaltete Gastsitzungen ausgegeben werden.
WIPE_USERS Löschen Sie alle Nutzer vom Gerät. Wenn Sie diesen Befehl auf dem Gerät ausführen, werden alle Nutzerprofildaten entfernt, die Geräterichtlinien und die Registrierung bleiben jedoch erhalten.
REMOTE_POWERWASH Löscht das Gerät im Powerwash. Wenn Sie diesen Befehl auf dem Gerät ausführen, werden alle Daten entfernt, einschließlich Nutzerrichtlinien, Geräterichtlinien und Registrierungsrichtlinien. Warnung: Dadurch wird das Gerät auf die Werkseinstellungen ohne Registrierung zurückgesetzt, es sei denn, es unterliegt einer erzwungenen oder automatischen Registrierung. Seien Sie vorsichtig, da diese Aktion nicht rückgängig gemacht werden kann.
DEVICE_START_CRD_SESSION Startet eine Chrome Remote Desktop-Sitzung.
CAPTURE_LOGS Systemprotokolle eines Kioskgeräts erfassen Die Protokolle können über den DownloadUrl-Link im Feld deviceFiles von chromeosdevices heruntergeladen werden.
FETCH_SUPPORT_PACKET Kann ein Supportpaket per Fernzugriff von einem Gerät abrufen. Das Supportpaket ist ein ZIP-Archiv, das verschiedene Systemprotokolle und Debug-Daten von einem ChromeOS-Gerät enthält. Das Supportpaket kann über den Download-URL-Link im Feld deviceFiles von chromeosdevices heruntergeladen werden.

Status

Stellt den Status des ausgegebenen Befehls dar.

Enums
STATE_UNSPECIFIED Der Befehlsstatus wurde nicht angegeben.
PENDING Ein nicht abgelaufener Befehl, der noch nicht an den Client gesendet wurde.
EXPIRED Der Befehl wurde nicht innerhalb der erwarteten Zeit vom Client ausgeführt.
CANCELLED Der Befehl wird vom Administrator abgebrochen, während er ausstehend ist.
SENT_TO_CLIENT Der Befehl wurde an den Client gesendet.
ACKED_BY_CLIENT Der Client hat geantwortet, dass er den Befehl erhalten hat.
EXECUTED_BY_CLIENT Der Client hat den Befehl (nicht) erfolgreich ausgeführt.

DirectoryChromeosdevicesCommandResult

Das Ergebnis der Ausführung eines Befehls.

JSON-Darstellung 
{
  "result": enum (CommandResultType),
  "executeTime": string,
  "errorMessage": string,
  "commandResultPayload": string
}
Felder
result

enum (CommandResultType)

Das Ergebnis des Befehls.
executeTime

string (Timestamp format)

Der Zeitpunkt, zu dem der Befehl ausgeführt wurde oder nicht ausgeführt werden konnte.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
errorMessage

string

Die Fehlermeldung mit einer kurzen Erklärung, warum der Befehl fehlgeschlagen ist. Wird nur angezeigt, wenn der Befehl fehlgeschlagen ist.
commandResultPayload

string

Die Nutzlast für das Befehlsergebnis. Die folgenden Befehle antworten mit einer Nutzlast:

  • DEVICE_START_CRD_SESSION: Die Nutzlast ist ein String-JSON-Objekt im Format { "url": url }. Die URL stellt einen Link zur Chrome Remote Desktop-Sitzung bereit.

CommandResultType

Der Typ des Befehlsergebnisses.

Enums
COMMAND_RESULT_TYPE_UNSPECIFIED Das Ergebnis des Befehls wurde nicht angegeben.
IGNORED Der Befehl wurde als veraltet ignoriert.
FAILURE Der Befehl konnte nicht erfolgreich ausgeführt werden.
SUCCESS Der Befehl wurde ausgeführt.

Methoden

get

 Ruft Befehlsdaten ab, die ein bestimmter Befehl an das Gerät ausgegeben hat.