Method: customer.devices.chromeos.issueCommand

Envoie une commande à l'appareil pour qu'il l'exécute.

Requête HTTP

POST https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
customerId

string

Immuable. ID du compte Google Workspace.
deviceId

string

Immuable. ID de l'appareil ChromeOS.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "commandType": enum (CommandType),
  "payload": string
}
Champs
commandType

enum (CommandType)

Type de commande.
payload

string

Charge utile de la commande. Ne la fournissez que si la commande la prend en charge. Les commandes suivantes permettent d'ajouter une charge utile:

  • SET_VOLUME: la charge utile est un objet JSON concaténé sous la forme: { "volume": 50 }. Le volume doit être un entier compris dans la plage [0,100].
  • DEVICE_START_CRD_SESSION: la charge utile peut être un objet JSON concaténé sous la forme: { "ackedUserPresence": true, "crdSessionType": string }. ackedUserPresence est une valeur booléenne. Par défaut, ackedUserPresence est défini sur false. Pour démarrer une session Bureau à distance Chrome pour un appareil actif, définissez ackedUserPresence sur true. crdSessionType ne peut sélectionner que les valeurs private (qui accorde à l'administrateur à distance le contrôle exclusif de l'appareil ChromeOS) ou shared (qui permet à l'administrateur et à l'utilisateur local de partager le contrôle de l'appareil ChromeOS). Si ce champ n'est pas défini, crdSessionType est défini par défaut sur shared.
  • REBOOT: la charge utile est un objet JSON concaténé sous la forme: { "user_session_delay_seconds": 300 }. user_session_delay_seconds correspond au nombre de secondes à attendre avant de redémarrer l'appareil si un utilisateur est connecté. Il doit s'agir d'un nombre entier compris dans la plage [0,300]. Lorsque la charge utile n'est pas présente pour le redémarrage, la valeur par défaut est 0. Remarque: Cela ne s'applique que si un utilisateur est connecté, y compris un invité. Si l'appareil est sur l'écran de connexion ou en mode Kiosque, la valeur n'est pas respectée et l'appareil redémarre immédiatement.
  • FETCH_SUPPORT_PACKET: la charge utile peut être un objet JSON concaténé sous la forme: {"supportPacketDetails":{ "issueCaseId": optional_support_case_id_string, "issueDescription": optional_issue_description_string, "requestedDataCollectors": [<liste de valeurs entières data_collector_enums séparées par une virgule>]}}
    La liste des data_collector_enums disponibles est la suivante: informations système Chrome (1), ID de plantage (2), informations sur la mémoire (3), hiérarchie de l'interface utilisateur (4), journaux de plate-forme ChromeOS supplémentaires (5), événement de l'appareil (6), vidage de débogage des NIC Intel WiFi (7), événements tactiles (8), Lacros (9), informations système Lacros (10), journaux ChromeOS Flex (11), informations DBus (12), routes réseau ChromeOS (13), journaux ChromeOS Shill (gestionnaire de connexion) (14), règles (15), état et journaux système ChromeOS (16), journaux système ChromeOS (17), journaux utilisateur ChromeOS Chrome (18), Bluetooth ChromeOS (19), périphériques d'entrée connectés ChromeOS (20), compteurs de trafic ChromeOS (21), clavier virtuel ChromeOS (22), état du réseau ChromeOS (23).
    Pour en savoir plus, consultez cet article d'aide.

Corps de la réponse

Réponse à l'émission d'une commande.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "commandId": string
}
Champs
commandId

string (int64 format)

ID unique de la commande émise, utilisé pour récupérer son état.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/admin.directory.device.chromeos

Pour en savoir plus, consultez le guide d'autorisation.