REST Resource: chromeosdevices

Ressource: ChromeOsDevice

Les appareils Google Chrome sont équipés de Chrome OS. Pour en savoir plus sur les tâches d'API courantes, consultez le guide du développeur.

Représentation JSON
{
  "deviceId": string,
  "serialNumber": string,
  "status": string,
  "lastSync": string,
  "supportEndDate": string,
  "annotatedUser": string,
  "annotatedLocation": string,
  "notes": string,
  "model": string,
  "meid": string,
  "orderNumber": string,
  "willAutoRenew": boolean,
  "osVersion": string,
  "platformVersion": string,
  "firmwareVersion": string,
  "macAddress": string,
  "bootMode": string,
  "lastEnrollmentTime": string,
  "kind": string,
  "recentUsers": [
    {
      "type": string,
      "email": string
    }
  ],
  "activeTimeRanges": [
    {
      "activeTime": integer,
      "date": string
    }
  ],
  "ethernetMacAddress": string,
  "annotatedAssetId": string,
  "etag": string,
  "diskVolumeReports": [
    {
      "volumeInfo": [
        {
          "volumeId": string,
          "storageTotal": string,
          "storageFree": string
        }
      ]
    }
  ],
  "systemRamTotal": string,
  "cpuStatusReports": [
    {
      "reportTime": string,
      "cpuUtilizationPercentageInfo": [
        integer
      ],
      "cpuTemperatureInfo": [
        {
          "temperature": integer,
          "label": string
        }
      ]
    }
  ],
  "cpuInfo": [
    {
      "model": string,
      "architecture": string,
      "maxClockSpeedKhz": integer,
      "logicalCpus": [
        {
          "maxScalingFrequencyKhz": integer,
          "currentScalingFrequencyKhz": integer,
          "idleDuration": string,
          "cStates": [
            {
              "displayName": string,
              "sessionDuration": string
            }
          ]
        }
      ]
    }
  ],
  "deviceFiles": [
    {
      "name": string,
      "type": string,
      "downloadUrl": string,
      "createTime": string
    }
  ],
  "systemRamFreeReports": [
    {
      "reportTime": string,
      "systemRamFreeInfo": [
        string
      ]
    }
  ],
  "lastKnownNetwork": [
    {
      "ipAddress": string,
      "wanIpAddress": string
    }
  ],
  "autoUpdateExpiration": string,
  "ethernetMacAddress0": string,
  "dockMacAddress": string,
  "manufactureDate": string,
  "orgUnitPath": string,
  "tpmVersionInfo": {
    "family": string,
    "specLevel": string,
    "manufacturer": string,
    "tpmModel": string,
    "firmwareVersion": string,
    "vendorSpecific": string
  },
  "screenshotFiles": [
    {
      "name": string,
      "type": string,
      "downloadUrl": string,
      "createTime": string
    }
  ],
  "orgUnitId": string,
  "osUpdateStatus": {
    object (OsUpdateStatus)
  },
  "firstEnrollmentTime": string,
  "lastDeprovisionTimestamp": string,
  "deprovisionReason": enum (DeprovisionReason),
  "deviceLicenseType": enum (DeviceLicenseType),
  "backlightInfo": [
    {
      object (BacklightInfo)
    }
  ]
}
Champs
deviceId

string

Identifiant unique de l'appareil Chrome.

serialNumber

string

Numéro de série de l'appareil Chrome saisi lors de son activation. Cette valeur est identique au numéro de série figurant dans l'onglet Appareils Chrome OS de la console d'administration.

status

string

État de l'appareil.

Les valeurs acceptées sont les suivantes :

  • ACTIVE: l'appareil est enregistré dans le domaine.
  • DELINQUENT: la licence annuelle du domaine a expiré et l'appareil ne reçoit plus les règles ni les paramètres. Lorsqu'une nouvelle licence est achetée, l'appareil repasse à l'état ACTIVE.
  • PRE_PROVISIONED: l'appareil a été enregistré pour l'enregistrement sans contact. Un appareil PRE_PROVISIONED peut être déplacé vers une autre unité organisationnelle ou supprimé. Une fois l'enregistrement terminé, l'appareil sera ACTIVE.
  • DEPROVISIONED: l'appareil ne peut plus être enregistré dans le domaine. La commande a été annulée. Les paramètres de l'appareil ont été mis en cache sur celui-ci. Si l'appareil est réactivé, les derniers paramètres système s'appliquent à celui-ci.
  • DISABLED: l'appareil a été désactivé par l'administrateur et ne peut pas être utilisé.
  • INACTIVE: l'appareil n'est pas enregistré dans le domaine.
  • RETURN_ARRIVED: la demande de remplacement de cet appareil est arrivée.
  • RETURN_REQUESTED: une demande de remplacement de cet appareil a été envoyée.
  • SHIPPED: l'appareil est expédié depuis l'inventaire de Google. (Obsolète)
  • UNKNOWN: l'état de l'appareil ne peut pas être déterminé.
lastSync

string

Date et heure de la dernière synchronisation des paramètres de règles entre l'appareil et la console d'administration. La valeur est au format de date et d'heure ISO 8601. L'heure correspond à la date complète suivie des heures, minutes et secondes, au format YYYY-MM-DDThh:mm:ssTZD. Exemple :2010-04-05T17:30:04+01:00

supportEndDate

string

Date finale de prise en charge de l'appareil. Cela ne s'applique qu'aux appareils achetés directement auprès de Google. La valeur est au format de date et d'heure ISO 8601. L'heure correspond à la date complète suivie des heures, minutes et secondes, au format YYYY-MM-DDThh:mm:ssTZD. Exemple :2010-04-05T17:30:04+01:00

annotatedUser

string

Utilisateur de l'appareil, tel qu'indiqué par l'administrateur. Il ne doit pas dépasser 100 caractères. Les valeurs vides sont autorisées.

annotatedLocation

string

Adresse ou emplacement de l'appareil, tel qu'indiqué par l'administrateur. Le nom de l'environnement ne peut pas comporter plus de 200 caractères. Les valeurs vides sont autorisées.

notes

string

Remarques concernant cet appareil ajoutées par l'administrateur. Vous pouvez rechercher cette propriété à l'aide du paramètre query de la méthode list. Ne doit pas dépasser 500 caractères Les valeurs vides sont autorisées.

model

string

Informations sur le modèle de l'appareil. Si l'appareil ne dispose pas de cette information, cette propriété n'est pas incluse dans la réponse.

meid

string

Identifiant MEID (Mobile Equipment Identifier) ou code IMEI (International Mobile Equipment Identity) de la carte mobile 3G d'un appareil mobile. Le code MEID/IMEI est généralement utilisé lors de l'ajout d'un appareil au forfait avec post-paiement d'un opérateur mobile. Si l'appareil ne dispose pas de cette information, cette propriété n'est pas incluse dans la réponse. Pour en savoir plus sur l'exportation d'une liste MEID/IMEI, consultez le guide du développeur.

orderNumber

string

Numéro de commande de l'appareil. Seuls les appareils achetés directement auprès de Google possèdent un numéro de commande.

willAutoRenew

boolean

Détermine si la prise en charge de l'appareil sera automatiquement renouvelée après la date de fin de la prise en charge. Cette propriété est en lecture seule.

osVersion

string

Version du système d'exploitation de l'appareil Chrome.

platformVersion

string

Version de la plate-forme de l'appareil Chrome.

firmwareVersion

string

Version du micrologiciel de l'appareil Chrome.

macAddress

string

Adresse MAC sans fil de l'appareil. Si l'appareil ne dispose pas de cette information, elle n'est pas incluse dans la réponse.

bootMode

string

Mode de démarrage de l'appareil. Les valeurs possibles sont :

  • Verified: l'appareil utilise une version valide de Chrome OS.
  • Dev: le commutateur matériel du développeur de l'appareil est activé. Au démarrage, l'appareil dispose d'un shell de ligne de commande. Pour obtenir un exemple de changement pour les développeurs, consultez les informations pour les développeurs Chromebook.
lastEnrollmentTime

string

Date et heure du dernier enregistrement de l'appareil. La valeur est au format de date et d'heure ISO 8601. L'heure correspond à la date complète suivie des heures, minutes et secondes, au format YYYY-MM-DDThh:mm:ssTZD. Exemple :2010-04-05T17:30:04+01:00 Pour plus d'informations sur l'enregistrement automatique et manuel, consultez le Centre d'aide Chrome.

kind

string

Type de ressource. Pour la ressource Chromeosdevices, la valeur est admin#directory#chromeosdevice.

recentUsers[]

object

Liste des utilisateurs récents de l'appareil, classés par ordre décroissant, en fonction de l'heure de leur dernière connexion.

recentUsers[].type

string

Type d'utilisateur.

Les valeurs acceptées sont les suivantes :

  • USER_TYPE_MANAGED: l'utilisateur est géré par le domaine.
  • USER_TYPE_UNMANAGED: l'utilisateur n'est pas géré par le domaine.
recentUsers[].email

string

Adresse e-mail de l'utilisateur. Cette valeur n'est présente que si le type d'utilisateur est USER_TYPE_MANAGED.

activeTimeRanges[]

object

Liste des périodes actives (lecture seule)

activeTimeRanges[].activeTime

integer

Durée d'utilisation en millisecondes.

activeTimeRanges[].date

string

Date d'utilisation.

ethernetMacAddress

string

Adresse MAC de l'appareil sur l'interface réseau Ethernet.

annotatedAssetId

string

Identifiant d'élément, tel qu'indiqué par un administrateur ou spécifié lors de l'inscription.

etag

string

ETag de la ressource.

diskVolumeReports[]

object

Rapports sur l'espace disque et autres informations sur les volumes installés/connectés

diskVolumeReports[].volumeInfo[]

object

Volumes de disque

diskVolumeReports[].volumeInfo[].volumeId

string

ID du volume

diskVolumeReports[].volumeInfo[].storageTotal

string (int64 format)

Espace disque total [en octets]

diskVolumeReports[].volumeInfo[].storageFree

string (int64 format)

Espace disque disponible [en octets]

systemRamTotal

string (int64 format)

RAM totale sur l'appareil en octets

cpuStatusReports[]

object

Rapports sur l'utilisation et la température du processeur (lecture seule)

cpuStatusReports[].reportTime

string

Date et heure de réception du rapport.

cpuStatusReports[].cpuUtilizationPercentageInfo[]

integer

cpuStatusReports[].cpuTemperatureInfo[]

object

Liste des échantillons de température du processeur.

cpuStatusReports[].cpuTemperatureInfo[].temperature

integer

Température en degrés Celsius.

cpuStatusReports[].cpuTemperatureInfo[].label

string

Étiquette du processeur

cpuInfo[]

object

Informations concernant les caractéristiques du processeur de l'appareil.

cpuInfo[].model

string

Nom du modèle du processeur.

cpuInfo[].architecture

string

Architecture du processeur

cpuInfo[].maxClockSpeedKhz

integer

Vitesse d'horloge maximale du processeur en kHz.

cpuInfo[].logicalCpus[]

object

Informations relatives aux processeurs logiques

cpuInfo[].logicalCpus[].maxScalingFrequencyKhz

integer

Fréquence maximale d'exécution du processeur autorisée, par règle.

cpuInfo[].logicalCpus[].currentScalingFrequencyKhz

integer

Fréquence actuelle à laquelle le processeur s'exécute.

cpuInfo[].logicalCpus[].idleDuration

string (Duration format)

Durée d'inactivité depuis le dernier démarrage.

Durée en secondes avec un maximum de neuf chiffres après la virgule, se terminant par "s". Exemple: "3.5s".

cpuInfo[].logicalCpus[].cStates[]

object

Les états C indiquent l'état de consommation d'énergie du processeur. Pour en savoir plus, consultez la documentation publiée par le fabricant des processeurs.

cpuInfo[].logicalCpus[].cStates[].displayName

string

Nom de l'État.

cpuInfo[].logicalCpus[].cStates[].sessionDuration

string (Duration format)

Temps passé dans l'état depuis le dernier redémarrage.

Durée en secondes avec un maximum de neuf chiffres après la virgule, se terminant par "s". Exemple: "3.5s".

deviceFiles[]

object

Liste des fichiers de l'appareil à télécharger (lecture seule)

deviceFiles[].name

string

Nom du fichier

deviceFiles[].type

string

File type

deviceFiles[].downloadUrl

string

URL de téléchargement du fichier

deviceFiles[].createTime

string

Date et heure de création du fichier

systemRamFreeReports[]

object

Rapports sur la quantité de mémoire RAM disponible (lecture seule)

systemRamFreeReports[].reportTime

string

Date et heure de réception du rapport.

systemRamFreeReports[].systemRamFreeInfo[]

string (int64 format)

lastKnownNetwork[]

object

Contient le dernier réseau connu (lecture seule)

lastKnownNetwork[].ipAddress

string

Adresse IP.

lastKnownNetwork[].wanIpAddress

string

Adresse IP WAN.

autoUpdateExpiration

string (int64 format)

(Lecture seule) Horodatage au terme duquel l'appareil cessera de recevoir les mises à jour ou l'assistance Chrome

ethernetMacAddress0

string

Adresse MAC (lecture seule) utilisée par le port Ethernet interne du Chromebook et pour l'interface réseau intégrée (Ethernet). Le format est composé de douze (12) chiffres hexadécimaux sans séparateur (lettres majuscules). Cette option n'est pertinente que pour certains appareils.

dockMacAddress

string

(Lecture seule) Adresse MAC intégrée de la station d'accueil à laquelle l'appareil est connecté. Configuration d'usine de l'adresse MAC (Media Access Control) attribuée pour être utilisée par une station d'accueil. Il est spécifiquement réservé aux règles MAC de transmission via l'appareil. Le format est composé de douze (12) chiffres hexadécimaux sans séparateur (lettres majuscules). Cette option n'est pertinente que pour certains appareils.

manufactureDate

string

(Lecture seule) Date de fabrication de l'appareil, au format aaaa-mm-jj.

orgUnitPath

string

Chemin d'accès parent complet contenant le nom de l'unité organisationnelle associée à l'appareil. Les noms de chemin ne sont pas sensibles à la casse. Si l'unité organisationnelle parente est l'organisation racine, elle est représentée par une barre oblique, /. Cette propriété peut être mise à jour à l'aide de l'API. Pour plus d'informations sur la création d'une structure organisationnelle pour votre appareil, consultez le Centre d'aide pour l'administration.

tpmVersionInfo

object

Trusted Platform Module (TPM) (lecture seule)

tpmVersionInfo.family

string

Famille TPM Nous utilisons l'encodage de style TPM 2.0, par exemple :
TPM 1.2: "1.2" -> 312e3200
TPM 2.0: "2.0" -> 322e3000

tpmVersionInfo.specLevel

string

Niveau de spécification du TPM. Consultez les spécifications de la bibliothèque pour TPM 2.0 et la spécification principale pour TPM 1.2.

tpmVersionInfo.manufacturer

string

Code fabricant du TPM.

tpmVersionInfo.tpmModel

string

Numéro de modèle du TPM.

tpmVersionInfo.firmwareVersion

string

Version du micrologiciel TPM.

tpmVersionInfo.vendorSpecific

string

Informations spécifiques au fournisseur, telles que son ID

screenshotFiles[]

object

Liste de fichiers de capture d'écran à télécharger. Le type est toujours "SCREENSHOT_FILE". (Lecture seule)

screenshotFiles[].name

string

Nom du fichier

screenshotFiles[].type

string

File type

screenshotFiles[].downloadUrl

string

URL de téléchargement du fichier

screenshotFiles[].createTime

string

Date et heure de création du fichier

orgUnitId

string

Identifiant unique de l'unité organisationnelle. orgUnitPath est une version lisible de orgUnitId. Bien que orgUnitPath puisse changer en renommant une unité organisationnelle dans le chemin d'accès, orgUnitId ne peut pas être modifié pour une unité organisationnelle spécifique. Cette propriété peut être mise à jour à l'aide de l'API. Pour plus d'informations sur la création d'une structure organisationnelle pour votre appareil, consultez le Centre d'aide pour l'administration.

osUpdateStatus

object (OsUpdateStatus)

État des mises à jour de l'OS de l'appareil.

firstEnrollmentTime

string

Date et heure du premier enregistrement de l'appareil.

lastDeprovisionTimestamp

string

(Lecture seule) Date et heure du dernier déprovisionnement de l'appareil.

deprovisionReason

enum (DeprovisionReason)

(Lecture seule) Motif du déprovisionnement.

deviceLicenseType

enum (DeviceLicenseType)

Uniquement en sortie. Type de licence de l'appareil

backlightInfo[]

object (BacklightInfo)

Uniquement en sortie. Contient des informations de rétroéclairage pour l'appareil.

OsUpdateStatus

Contient des informations sur l'état actuel de la mise à jour de l'OS.

Représentation JSON
{
  "state": enum (UpdateState),
  "targetOsVersion": string,
  "targetKioskAppVersion": string,
  "updateTime": string,
  "updateCheckTime": string,
  "rebootTime": string
}
Champs
state

enum (UpdateState)

État de la mise à jour de l'OS.

targetOsVersion

string

Nouvelle version de la plate-forme de l'image de l'OS en cours de téléchargement et d'application. Il n'est défini que lorsque l'état de la mise à jour est UPDATE_STATUS_DOWNLOAD_IN_PROGRESS ou UPDATE_STATUS_NEED_REBOOT. Notez qu'il peut s'agir d'un "0.0.0.0" factice pour UPDATE_STATUS_NEED_REBOOT dans certains cas particuliers (par exemple, le moteur de mise à jour redémarre sans redémarrage).

targetKioskAppVersion

string

Nouvelle version de plate-forme requise pour l'application kiosque mise à jour en attente.

updateTime

string

Date et heure de la dernière mise à jour réussie de l'OS.

updateCheckTime

string

Date et heure de la dernière recherche de mises à jour.

rebootTime

string

Date et heure du dernier redémarrage.

UpdateState

État de la mise à jour de l'OS.

Enums
UPDATE_STATE_UNSPECIFIED L'état de la mise à jour n'est pas spécifié.
UPDATE_STATE_NOT_STARTED Une mise à jour est en attente, mais elle n'a pas commencé.
UPDATE_STATE_DOWNLOAD_IN_PROGRESS La mise à jour en attente est en cours de téléchargement.
UPDATE_STATE_NEED_REBOOT L'appareil est prêt à installer la mise à jour, mais doit redémarrer.

DeprovisionReason

Motif du déprovisionnement d'un appareil ChromeOS.

Enums
DEPROVISION_REASON_UNSPECIFIED Le motif de déprovisionnement est inconnu.
DEPROVISION_REASON_SAME_MODEL_REPLACEMENT Remplacement par un modèle identique. Vous disposez d'une autorisation de retour du matériel (ARM) ou vous remplacez un appareil défectueux sous garantie par le même modèle.
DEPROVISION_REASON_UPGRADE

L'appareil a été mis à niveau.

DEPROVISION_REASON_DOMAIN_MOVE

Le domaine de l'appareil a été modifié.

DEPROVISION_REASON_SERVICE_EXPIRATION

Le service a expiré pour l'appareil.

DEPROVISION_REASON_OTHER

La gestion de l'appareil a été annulée pour une ancienne raison qui n'est plus prise en charge.

DEPROVISION_REASON_DIFFERENT_MODEL_REPLACEMENT Remplacement par un autre modèle. Vous remplacez cet appareil par un modèle plus récent.
DEPROVISION_REASON_RETIRING_DEVICE Retrait du parc. Vous donnez, jetez ou mettez au rebut l'appareil.
DEPROVISION_REASON_UPGRADE_TRANSFER Transfert de licence ChromeOS Flex. Il s'agit d'un appareil ChromeOS Flex que vous remplacez par un Chromebook sous un an.
DEPROVISION_REASON_NOT_REQUIRED Aucun motif n'était requis. Par exemple, les licences ont été restituées au groupe de licences du client.
DEPROVISION_REASON_REPAIR_CENTER L'appareil a été déprovisionné par le centre de réparation. Ne peut être défini que par le centre de réparation pendant l'ARM.

DeviceLicenseType

Type de licence de cet appareil.

Enums
DEVICE_LICENSE_TYPE_UNSPECIFIED Le type de licence est inconnu.
ENTERPRISE L'appareil est fourni avec une licence permanente Chrome Enterprise Upgrade.
ENTERPRISE_UPGRADE L'appareil dispose d'une licence annuelle Chrome Enterprise Upgrade autonome.
EDUCATION_UPGRADE L'appareil dispose d'une licence permanente Chrome Education Upgrade autonome.
EDUCATION L'appareil est fourni avec une licence permanente Chrome Education Upgrade.
KIOSK_UPGRADE L'appareil dispose d'une licence Kiosk Upgrade annuelle.

BacklightInfo

Informations sur le rétroéclairage de l'appareil.

Représentation JSON
{
  "path": string,
  "maxBrightness": integer,
  "brightness": integer
}
Champs
path

string

Uniquement en sortie. Chemin vers ce rétroéclairage sur le système. Utile si l'appelant doit établir une corrélation avec d'autres informations.

maxBrightness

integer

Uniquement en sortie. Luminosité maximale du rétroéclairage.

brightness

integer

Uniquement en sortie. Luminosité actuelle du rétroéclairage, comprise entre 0 et la luminosité maximale.

Méthodes

action
(deprecated)

Utilisez plutôt BatchChangeChromeOsDeviceStatus.

get

Récupère les propriétés d'un appareil Chrome OS.

list

Récupère une liste paginée des appareils Chrome OS d'un compte.

moveDevicesToOu

Déplace ou insère plusieurs appareils Chrome OS dans une unité organisationnelle.

patch

Met à jour les propriétés pouvant être mises à jour d'un appareil, telles que annotatedUser, annotatedLocation, notes, orgUnitPath ou annotatedAssetId.

update

Met à jour les propriétés pouvant être mises à jour d'un appareil, telles que annotatedUser, annotatedLocation, notes, orgUnitPath ou annotatedAssetId.