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 Befehlstyp.
issueTime

string (Timestamp format)

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

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. 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 der Befehl nicht innerhalb dieses Zeitraums ausgeführt wird, läuft er ab.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. 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 vom Befehl angegebene Nutzlast, falls vorhanden.

CommandType

Gibt den Befehlstyp an, 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 mit Kioskmodus und verwalteten Gastsitzungen sowie für normale 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 Stellen Sie die Lautstärke des Geräts ein. 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 eine Datenlöschung gelöscht. Durch die Ausführung dieses Befehls auf dem Gerät 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. Verwenden Sie diese Option mit Bedacht, da die entsprechende 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 Link „downloadUrl“ im Feld deviceFiles von chromeosdevices heruntergeladen werden.
FETCH_CRD_AVAILABILITY_INFO Hier werden Informationen abgerufen, anhand derer die Verfügbarkeit von Chrome Remote Desktop (CRD) auf dem Gerät bestimmt wird.
FETCH_SUPPORT_PACKET Supportpaket per Fernzugriff von einem Gerät abrufen Das Supportpaket ist ein ZIP-Archiv, das verschiedene Systemprotokolle und Debugdaten von einem ChromeOS-Gerät enthält. Das Supportpaket kann über den Link „downloadURL“ im Feld deviceFiles von chromeosdevices heruntergeladen werden.

Status

Gibt den Status des erteilten 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 der erwarteten Zeit ausgeführt.
CANCELLED Der Befehl wird vom Administrator storniert, 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 erfolgreich (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 die Ausführung fehlgeschlagen ist.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. 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 JSON-Objekt im Stringformat in der Form: { "url": url }. Die URL stellt einen Link zur Chrome Remote Desktop-Sitzung bereit.

CommandResultType

Der Typ des Befehlsergebnisses.

Enums
COMMAND_RESULT_TYPE_UNSPECIFIED Das Befehlsergebnis wurde nicht angegeben.
IGNORED Der Befehl wurde ignoriert, da er veraltet ist.
FAILURE Der Befehl konnte nicht erfolgreich ausgeführt werden.
SUCCESS Der Befehl wurde erfolgreich ausgeführt.

Methoden

get

 Hier werden Befehlsdaten für einen bestimmten Befehl abgerufen, der an das Gerät gesendet wurde.