REST Resource: customer.devices.chromeos.commands

Ressource: DirectoryChromeosdevicesCommand

Informationen zu einem Befehl, der an ein Gerät gesendet 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 Nanosekundenauflösung 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 dieses Zeitraums ausführt, ist er abgelaufen.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung 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 war nicht angegeben.
REBOOT Starten Sie das Gerät neu. Sie kann nur für Kioske und Geräte mit verwalteten Gastsitzungen ausgestellt werden.
TAKE_A_SCREENSHOT Machen Sie 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. Sie kann nur für Kioske und Geräte mit verwalteten Gastsitzungen ausgestellt werden.
WIPE_USERS Entfernen Sie alle Nutzer vom Gerät. Wenn Sie diesen Befehl auf dem Gerät ausführen, werden alle Nutzerprofildaten entfernt. Geräterichtlinien und Registrierungen bleiben jedoch erhalten.
REMOTE_POWERWASH Die Daten auf dem Gerät werden durch einen Powerwash gelöscht. Wenn Sie diesen Befehl auf dem Gerät ausführen, werden alle Daten entfernt, einschließlich Nutzer-, Geräte- 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. Diese Aktion kann nicht rückgängig gemacht werden.
DEVICE_START_CRD_SESSION Startet eine Chrome Remote Desktop-Sitzung.
CAPTURE_LOGS Systemprotokolle eines Kioskgeräts erfassen Du kannst die Protokolle über den „downloadUrl“-Link im Feld „deviceFiles“ von chromeosdevices herunterladen.
FETCH_SUPPORT_PACKET Supportpaket per Fernzugriff von einem Gerät abrufen. Das Supportpaket ist ein ZIP-Archiv, das verschiedene Systemprotokolle und Fehlerbehebungsdaten eines ChromeOS-Geräts enthält. Das Supportpaket kann über den DownloadURL-Link im Feld „deviceFiles“ von chromeosdevices heruntergeladen werden.

Bundesstaat

Stellt den Status des ausgegebenen Befehls dar.

Enums
STATE_UNSPECIFIED Der Befehlsstatus war nicht angegeben.
PENDING Ein nicht abgelaufener Befehl, der noch nicht an den Client gesendet wurde.
EXPIRED Der Befehl wurde vom Client nicht innerhalb der erwarteten Zeit ausgeführt.
CANCELLED Der Befehl wird vom Administrator abgebrochen, während er sich im Status PENDING befindet.
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) 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 Nanosekundenauflösung 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 als String definiertes JSON-Objekt im Format { "url": url }. Die URL enthält einen Link zur Chrome Remote Desktop-Sitzung.

CommandResultType

Der Typ des Befehlsergebnisses.

Enums
COMMAND_RESULT_TYPE_UNSPECIFIED Das Befehlsergebnis war nicht angegeben.
IGNORED Der Befehl wurde als „veraltet“ ignoriert.
FAILURE Der Befehl konnte nicht ausgeführt werden.
SUCCESS Der Befehl wurde erfolgreich ausgeführt.

Methoden

get

 Ruft Befehlsdaten ab, die von einem bestimmten Befehl an das Gerät gesendet werden.