REST Resource: customer.devices.chromeos.commands

Ressource: DirectoryChromeosdevicesCommand

Informations concernant une commande envoyée à un appareil.

Représentation JSON
{
  "commandId": string,
  "type": enum (CommandType),
  "issueTime": string,
  "state": enum (State),
  "commandExpireTime": string,
  "commandResult": {
    object (DirectoryChromeosdevicesCommandResult)
  },
  "payload": string
}
Champs
commandId

string (int64 format)

ID unique d'une commande d'appareil.

type

enum (CommandType)

Type de la commande.

issueTime

string (Timestamp format)

Horodatage de l'émission de la commande par l'administrateur.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

state

enum (State)

Indique l'état de la commande.

commandExpireTime

string (Timestamp format)

Heure d'expiration de la commande. Si l'appareil n'exécute pas la commande dans ce délai, elle expire.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

commandResult

object (DirectoryChromeosdevicesCommandResult)

Résultat de l'exécution de la commande.

payload

string

Charge utile spécifiée par la commande, le cas échéant.

CommandType

Permet de déterminer le type de commande que l'appareil doit exécuter.

Enums
COMMAND_TYPE_UNSPECIFIED Le type de commande n'a pas été spécifié.
REBOOT Redémarrez l'appareil. Ne peut être attribué qu'aux appareils de session Invité gérée et en mode Kiosque.
TAKE_A_SCREENSHOT Prenez une capture d'écran de l'appareil. Uniquement disponible si l'appareil est en mode Kiosque.
SET_VOLUME Réglez le volume de l'appareil. Ne peut être attribué qu'aux appareils de session Invité gérée et en mode Kiosque.
WIPE_USERS effacer tous les comptes utilisateur de l'appareil ; L'exécution de cette commande sur l'appareil supprimera toutes les données de profil utilisateur, mais les règles relatives à l'appareil et son enregistrement seront conservées.
REMOTE_POWERWASH Permet d'effacer les données de l'appareil à l'aide d'un Powerwash. L'exécution de cette commande sur l'appareil supprime toutes les données, y compris les règles relatives aux utilisateurs, les règles relatives aux appareils et les règles d'enregistrement. Avertissement: Cette opération rétablira la configuration d'usine de l'appareil et ne sera pas enregistré, sauf s'il fait l'objet d'un enregistrement forcé ou automatique. À utiliser avec précaution, car cette action est irréversible.
DEVICE_START_CRD_SESSION Démarre une session de bureau à distance Chrome.
CAPTURE_LOGS Capturez les journaux système d'un appareil en mode kiosque. Les journaux peuvent être téléchargés à partir du lien downloadUrl présent dans le champ deviceFiles de chromeosdevices.
FETCH_SUPPORT_PACKET Récupérer à distance le paquet d'assistance d'un appareil Le paquet d'assistance est une archive ZIP contenant divers journaux système et données de débogage d'un appareil ChromeOS. Le kit d'assistance peut être téléchargé à partir du lien "downloadURL" présent dans le champ deviceFiles de chromeosdevices

État

Représente l'état de la commande émise.

Enums
STATE_UNSPECIFIED L'état de la commande n'a pas été spécifié.
PENDING Une commande en cours de validité n'a pas encore été envoyée au client.
EXPIRED La commande n'a pas été exécutée par le client dans les délais prévus.
CANCELLED La commande est annulée par l'administrateur lorsqu'elle est en attente.
SENT_TO_CLIENT La commande a été envoyée au client.
ACKED_BY_CLIENT Le client a répondu qu'il avait reçu la commande.
EXECUTED_BY_CLIENT Le client a (non) exécuté la commande.

DirectoryChromeosdevicesCommandResult

Résultat de l'exécution d'une commande.

Représentation JSON
{
  "result": enum (CommandResultType),
  "executeTime": string,
  "errorMessage": string,
  "commandResultPayload": string
}
Champs
result

enum (CommandResultType)

Résultat de la commande.

executeTime

string (Timestamp format)

Heure à laquelle la commande a été exécutée ou a échoué.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

errorMessage

string

Message d'erreur avec une brève explication sur la raison de l'échec de la commande. Présent uniquement en cas d'échec de la commande.

commandResultPayload

string

Charge utile du résultat de la commande. Les commandes suivantes répondent avec une charge utile:

  • DEVICE_START_CRD_SESSION : la charge utile est un objet JSON concaténé au format { "url": url }. L'URL fournit un lien vers la session du Bureau à distance Chrome.

CommandResultType

Type du résultat de la commande.

Enums
COMMAND_RESULT_TYPE_UNSPECIFIED Le résultat de la commande n'a pas été spécifié.
IGNORED La commande a été ignorée, car elle était obsolète.
FAILURE Impossible d'exécuter la commande.
SUCCESS La commande a bien été exécutée.

Méthodes

get

Récupère les données de commande envoyées à l'appareil.