REST Resource: customer.devices.chromeos.commands

Ressource: DirectoryChromeosdevicesCommand

Informations sur 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)

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

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
state

enum (State)

Indique l'état de la commande.
commandExpireTime

string (Timestamp format)

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

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
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éfinit 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 délivré pour les appareils en mode kiosque et les appareils avec session Invité gérée, ainsi que pour les appareils standards exécutant ChromeOS version 113 ou ultérieure.
TAKE_A_SCREENSHOT Effectuez 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 peut être émis que pour les appareils en mode Kiosque et les appareils avec session Invité gérée.
WIPE_USERS Effacez les données de tous les utilisateurs de l'appareil. L'exécution de cette commande sur l'appareil supprime toutes les données de profil utilisateur, mais conserve les règles relatives aux appareils et les données d'inscription.
REMOTE_POWERWASH Efface l'appareil en effectuant un nettoyage complet. L'exécution de cette commande sur l'appareil supprime toutes les données, y compris les règles utilisateur, 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 vous perdrez l'inscription, sauf si l'appareil fait l'objet d'une inscription forcée ou automatique. Utilisez cette option avec prudence, car cette action est irréversible.
DEVICE_START_CRD_SESSION Démarre une session du 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_CRD_AVAILABILITY_INFO Récupère les informations qui déterminent la disponibilité du Bureau à distance Chrome (CRD) sur l'appareil.
FETCH_SUPPORT_PACKET Récupérez à 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 package 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'était pas spécifié.
PENDING Commande non expirée qui 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 alors qu'elle est en attente.
SENT_TO_CLIENT La commande a été envoyée au client.
ACKED_BY_CLIENT Le client a indiqué avoir reçu la commande.
EXECUTED_BY_CLIENT Le client a (ou n'a pas) correctement 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 non.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
errorMessage

string

Message d'erreur avec une brève explication 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 renvoient 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 Chrome Remote Desktop.

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 est obsolète.
FAILURE L'exécution de la commande a échoué.
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.