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, der angibt, wann der Befehl vom Administrator ausgegeben wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
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, läuft er ab.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
commandResult

object (DirectoryChromeosdevicesCommandResult)

Das Ergebnis der Befehlsausführung.
payload

string

Die Nutzlast, die im Befehl angegeben wurde, 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 Geräte im Kioskmodus und mit verwalteten Gastsitzungen sowie für reguläre Geräte mit ChromeOS-Version 113 oder höher 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 Lautstärke des Geräts einstellen Kann nur für Kioskgeräte und Geräte mit verwalteten Gastsitzungen ausgestellt werden.
WIPE_USERS Löschen Sie alle Nutzerdaten auf dem Gerät. Wenn Sie diesen Befehl auf dem Gerät ausführen, werden alle Daten zu Nutzerprofilen entfernt, Geräterichtlinien und Registrierungsdaten bleiben aber erhalten.
REMOTE_POWERWASH Das Gerät wird durch Ausführen eines Powerwash-Vorgangs zurückgesetzt. Wenn dieser Befehl auf dem Gerät ausgeführt wird, 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 Logs können über den Link „downloadUrl“ im Feld deviceFiles von chromeosdevices heruntergeladen werden.
FETCH_CRD_AVAILABILITY_INFO Ruft die verfügbaren Typen von Chrome Remote Desktop-Sitzungen (privat oder gemeinsam genutzt) ab, die für die Remoteverbindung zum Gerät verwendet werden können.
FETCH_SUPPORT_PACKET Supportpaket per Remote-Zugriff von einem Gerät abrufen Ein Supportpaket ist ein ZIP-Archiv, das verschiedene Systemprotokolle und Debugging-Daten von einem ChromeOS-Gerät enthält. Das Support-Paket kann über den Link „downloadURL“ im Feld deviceFiles von chromeosdevices heruntergeladen werden.

Status

Gibt den Status des ausgegebenen Befehls an.

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 vom Client nicht innerhalb des erwarteten Zeitrahmens ausgeführt.
CANCELLED Der Befehl wird vom Administrator abgebrochen, während er den Status „AUSSTEHEND“ hat.
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 die Ausführung fehlgeschlagen ist.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
errorMessage

string

Die Fehlermeldung mit einer kurzen Erklärung, warum der Befehl fehlgeschlagen ist. Nur vorhanden, wenn der Befehl fehlgeschlagen ist.
commandResultPayload

string

Die Nutzlast für das Befehlsergebnis. Die folgenden Befehle geben eine Nutzlast zurück:

  • DEVICE_START_CRD_SESSION: Die Nutzlast ist ein in einen String umgewandeltes JSON-Objekt in der Form: { "url": url }. Die angegebene URL verweist auf die Chrome Remote Desktop-Sitzung und erfordert die Authentifizierung nur mit dem email, das mit der Ausführung des Befehls verknüpft ist.
  • FETCH_CRD_AVAILABILITY_INFO: Die Nutzlast ist ein String-JSON-Objekt im folgenden Format: { "deviceIdleTimeInSeconds": number, "userSessionType": string, "remoteSupportAvailability": string, "remoteAccessAvailability": string }. Das Feld „remoteSupportAvailability“ wird auf „AVAILABLE“ gesetzt, wenn eine shared-CRD-Sitzung für das Gerät verfügbar ist. Das Feld „remoteAccessAvailability“ wird auf „AVAILABLE“ gesetzt, wenn eine private-CRD-Sitzung für das Gerät verfügbar ist.

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 ausgeführt werden.
SUCCESS Der Befehl wurde ausgeführt.

Methoden

get

 Ruft Befehlsdaten für einen bestimmten Befehl ab, der an das Gerät gesendet wurde.