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)

Code temporel de l'émission de la commande par l'administrateur.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. 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, la commande expire.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. 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

Détermine 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. Peut être émis pour les appareils en mode kiosque et de session Invité gérée, ainsi que pour les appareils standards exécutant ChromeOS 113 ou une version ultérieure.
TAKE_A_SCREENSHOT Prenez une capture d'écran de l'appareil. Disponible uniquement si l'appareil est en mode Kiosque.
SET_VOLUME Réglez le volume de l'appareil. ne peuvent être émises que pour les appareils en mode Kiosque et les sessions Invité gérées ;
WIPE_USERS Effacez tous les utilisateurs de l'appareil. Si vous exécutez cette commande sur l'appareil, toutes les données de profil utilisateur seront supprimées, mais les règles relatives à l'appareil et l'enregistrement seront conservés.
REMOTE_POWERWASH Efface les données de l'appareil en effectuant un Powerwash. Si vous exécutez cette commande sur l'appareil, toutes les données seront supprimées, y compris les règles relatives aux utilisateurs et aux appareils, ainsi que les règles d'enregistrement. Avertissement: Cette opération rétablira la configuration d'usine de l'appareil sans aucun enregistrement, sauf s'il fait l'objet d'un enregistrement forcé ou automatique. À utiliser avec précaution, car il s'agit d'une action irréversible.
DEVICE_START_CRD_SESSION Démarre une session de bureau à distance Chrome.
CAPTURE_LOGS Enregistrez 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 des chromeosdevices
FETCH_SUPPORT_PACKET Récupérer à distance les paquets d'assistance d'un appareil Le dossier d'assistance est une archive ZIP contenant divers journaux système et données de débogage d'un appareil ChromeOS. Vous pouvez télécharger la formule d'assistance en cliquant sur le 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 non expirée n'a pas encore été envoyée au client.
EXPIRED La commande n'a pas été exécutée par le client dans le délai prévu.
CANCELLED La commande est annulée par l'administrateur lorsque l'état "PENDING" (en attente) est activé.
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 exécuté la commande (non) avec succès.

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é.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

errorMessage

string

Message d'erreur avec une brève explication de la raison de l'échec de la commande. Présent uniquement si la commande a échoué.

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é sous la forme { "url": url }. L'URL fournit un lien vers la session du Bureau à distance Chrome.

CommandResultType

Type de résultat de la commande.

Enums
COMMAND_RESULT_TYPE_UNSPECIFIED Le résultat de la commande n'était pas spécifié.
IGNORED La commande a été ignorée, car elle est 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 d'une commande spécifique envoyée à l'appareil.