- Resource: TelemetryDevice
- CpuInfo
- Architecture
- CpuStatusReport
- CpuTemperatureInfo
- MemoryInfo
- MemoryStatusReport
- NetworkStatusReport
- OsUpdateStatus
- UpdateState
- GraphicsInfo
- GraphicsAdapterInfo
- GraphicsStatusReport
- DisplayInfo
- BatteryInfo
- BatteryStatusReport
- BatterySampleReport
- BatteryHealth
- StorageInfo
- DiskVolume
- StorageStatusReport
- DiskInfo
- AudioStatusReport
- Methods
Resource: TelemetryDevice
Telemetry data collected from a managed device.
JSON representation |
---|
{ "name": string, "customer": string, "orgUnitId": string, "deviceId": string, "serialNumber": string, "cpuInfo": [ { object ( |
Fields | |
---|---|
name |
Output only. Resource name of the device. |
customer |
Output only. Google Workspace Customer whose enterprise enrolled the device. |
orgUnitId |
Output only. Organization unit ID of the device. |
deviceId |
Output only. The unique Directory API ID of the device. This value is the same as the Admin Console's Directory API ID in the ChromeOS Devices tab |
serialNumber |
Output only. Device serial number. This value is the same as the Admin Console's Serial Number in the ChromeOS Devices tab. |
cpuInfo[] |
Output only. Information regarding CPU specs for the device. |
cpuStatusReport[] |
Output only. CPU status reports collected periodically sorted in a decreasing order of |
memoryInfo |
Output only. Information regarding memory specs for the device. |
memoryStatusReport[] |
Output only. Memory status reports collected periodically sorted decreasing by |
networkStatusReport[] |
Output only. Network specs collected periodically. |
osUpdateStatus[] |
Output only. Contains relevant information regarding ChromeOS update status. |
graphicsInfo |
Output only. Contains information regarding Graphic peripherals for the device. |
graphicsStatusReport[] |
Output only. Graphics reports collected periodically. |
batteryInfo[] |
Output only. Information on battery specs for the device. |
batteryStatusReport[] |
Output only. Battery reports collected periodically. |
storageInfo |
Output only. Information of storage specs for the device. |
storageStatusReport[] |
Output only. Storage reports collected periodically. |
audioStatusReport[] |
Output only. Audio reports collected periodically sorted in a decreasing order of |
CpuInfo
CPU specs for a CPU.
JSON representation |
---|
{
"model": string,
"architecture": enum ( |
Fields | |
---|---|
model |
Output only. The CPU model name. Example: Intel(R) Core(TM) i5-8250U CPU @ 1.60GHz |
architecture |
Output only. The CPU architecture. |
maxClockSpeed |
Output only. The max CPU clock speed in kHz. |
Architecture
Architechture type for the CPU.
Enums | |
---|---|
ARCHITECTURE_UNSPECIFIED |
Architecture unknown. |
X64 |
x64 architecture |
CpuStatusReport
Contains samples of the cpu status reports.
JSON representation |
---|
{
"reportTime": string,
"sampleFrequency": string,
"cpuUtilizationPct": integer,
"cpuTemperatureInfo": [
{
object ( |
Fields | |
---|---|
reportTime |
Output only. The timestamp in milliseconds representing time at which this report was sampled. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
sampleFrequency |
Output only. Frequency the report is sampled. A duration in seconds with up to nine fractional digits, terminated by ' |
cpuUtilizationPct |
Output only. Sample of CPU utilization (0-100 percent). |
cpuTemperatureInfo[] |
Output only. CPU temperature sample info per CPU core in Celsius |
CpuTemperatureInfo
CPU temperature of a device. Sampled per CPU core in Celsius
JSON representation |
---|
{ "temperatureCelsius": integer, "label": string } |
Fields | |
---|---|
temperatureCelsius |
Output only. CPU temperature in Celsius. |
label |
Output only. CPU label. Example: Core 0 |
MemoryInfo
Memory information of a device.
JSON representation |
---|
{ "totalRamBytes": string, "availableRamBytes": string } |
Fields | |
---|---|
totalRamBytes |
Output only. Total RAM in bytes. |
availableRamBytes |
Output only. Amount of available RAM in bytes. |
MemoryStatusReport
Contains samples of memory status reports.
JSON representation |
---|
{ "reportTime": string, "sampleFrequency": string, "systemRamFreeBytes": string, "pageFaults": integer } |
Fields | |
---|---|
reportTime |
Output only. The timestamp in milliseconds representing time at which this report was sampled. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
sampleFrequency |
Output only. Frequency the report is sampled. A duration in seconds with up to nine fractional digits, terminated by ' |
systemRamFreeBytes |
Output only. Amount of free RAM in bytes (unreliable due to Garbage Collection). |
pageFaults |
Output only. Number of page faults during this collection |
NetworkStatusReport
State of visible/configured networks.
JSON representation |
---|
{ "reportTime": string, "sampleFrequency": string, "signalStrengthDbm": integer, "lanIpAddress": string, "gatewayIpAddress": string } |
Fields | |
---|---|
reportTime |
Output only. Time at which the network state was reported. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
sampleFrequency |
Output only. Frequency the report is sampled. A duration in seconds with up to nine fractional digits, terminated by ' |
signalStrengthDbm |
Output only. Signal strength for wireless networks measured in decibels. |
lanIpAddress |
Output only. LAN IP address. |
gatewayIpAddress |
Output only. Gateway IP address. |
OsUpdateStatus
Contains information regarding the current OS update status.
JSON representation |
---|
{
"updateState": enum ( |
Fields | |
---|---|
updateState |
Output only. Current state of the os update. |
newPlatformVersion |
Output only. New platform version of the os image being downloaded and applied. It is only set when update status is OS_IMAGE_DOWNLOAD_IN_PROGRESS or OS_UPDATE_NEED_REBOOT. Note this could be a dummy "0.0.0.0" for OS_UPDATE_NEED_REBOOT status for some edge cases, e.g. update engine is restarted without a reboot. |
newRequestedPlatformVersion |
Output only. New requested platform version from the pending updated kiosk app. |
lastUpdateTime |
Output only. Timestamp of the last successful update. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
lastUpdateCheckTime |
Output only. Timestamp of the last update check. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
lastRebootTime |
Output only. Timestamp of the last reboot. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
UpdateState
State of the OS update
Enums | |
---|---|
UPDATE_STATE_UNSPECIFIED |
State unspecified. |
OS_IMAGE_DOWNLOAD_NOT_STARTED |
OS has not started downloading. |
OS_IMAGE_DOWNLOAD_IN_PROGRESS |
OS has started download on device. |
OS_UPDATE_NEED_REBOOT |
Device needs reboot to finish upload. |
GraphicsInfo
Information of the graphics subsystem.
JSON representation |
---|
{
"adapterInfo": {
object ( |
Fields | |
---|---|
adapterInfo |
Output only. Information about the graphics adapter (GPU). |
GraphicsAdapterInfo
Information of a graphics adapter (GPU).
JSON representation |
---|
{ "adapter": string, "driverVersion": string, "deviceId": string } |
Fields | |
---|---|
adapter |
Output only. Adapter name. Example: Mesa DRI Intel(R) UHD Graphics 620 (Kabylake GT2). |
driverVersion |
Output only. Version of the GPU driver. |
deviceId |
Output only. Represents the graphics card device id. |
GraphicsStatusReport
Information of the graphics subsystem.
JSON representation |
---|
{
"reportTime": string,
"displays": [
{
object ( |
Fields | |
---|---|
reportTime |
Output only. Time at which the graphics data was reported. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
displays[] |
Output only. Information about the displays for the device. |
DisplayInfo
Information for a display.
JSON representation |
---|
{ "deviceId": string, "resolutionWidth": integer, "resolutionHeight": integer, "refreshRate": integer, "isInternal": boolean } |
Fields | |
---|---|
deviceId |
Output only. Represents the graphics card device id. |
resolutionWidth |
Output only. Resolution width in pixels. |
resolutionHeight |
Output only. Resolution height in pixels. |
refreshRate |
Output only. Refresh rate in Hz. |
isInternal |
Output only. Indicates if display is internal or not. |
BatteryInfo
Battery info
JSON representation |
---|
{
"serialNumber": string,
"manufacturer": string,
"designCapacity": string,
"designMinVoltage": integer,
"manufactureDate": {
object ( |
Fields | |
---|---|
serialNumber |
Output only. Battery serial number. |
manufacturer |
Output only. Battery manufacturer. |
designCapacity |
Output only. Design capacity (mAmpere-hours). |
designMinVoltage |
Output only. Designed minimum output voltage (mV) |
manufactureDate |
Output only. The date the battery was manufactured. |
technology |
Output only. Technology of the battery. Example: Li-ion |
BatteryStatusReport
Status data for battery.
JSON representation |
---|
{ "reportTime": string, "serialNumber": string, "sample": [ { object ( |
Fields | |
---|---|
reportTime |
Output only. Timestamp of when the sample was collected on device A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
serialNumber |
Output only. Battery serial number. |
sample[] |
Output only. Sampling data for the battery sorted in a decreasing order of |
batteryHealth |
Output only. Battery health. |
fullChargeCapacity |
Output only. Full charge capacity (mAmpere-hours). |
cycleCount |
Output only. Cycle count. |
BatterySampleReport
Sampling data for battery.
JSON representation |
---|
{ "reportTime": string, "voltage": string, "remainingCapacity": string, "temperature": integer, "dischargeRate": integer, "chargeRate": integer, "current": string, "status": string } |
Fields | |
---|---|
reportTime |
Output only. Timestamp of when the sample was collected on device A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
voltage |
Output only. Battery voltage (millivolt). |
remainingCapacity |
Output only. Battery remaining capacity (mAmpere-hours). |
temperature |
Output only. Temperature in Celsius degrees. |
dischargeRate |
Output only. The battery discharge rate measured in mW. Positive if the battery is being discharged, negative if it's being charged. |
chargeRate |
Output only. Battery charge percentage. |
current |
Output only. Battery current (mA). |
status |
Output only. Battery status read from sysfs. Example: Discharging |
BatteryHealth
Represents the battery's current health.
Enums | |
---|---|
BATTERY_HEALTH_UNSPECIFIED |
Health unknown. |
BATTERY_HEALTH_NORMAL |
Battery is healthy. |
BATTERY_REPLACE_SOON |
Battery is moderately unhealthy and should be replaced soon. |
BATTERY_REPLACE_NOW |
Battery is unhealthy and should be replaced. |
StorageInfo
Status data for storage.
JSON representation |
---|
{
"volume": [
{
object ( |
Fields | |
---|---|
volume[] |
Information for disk volumes |
availableDiskBytes |
The available space for user data storage in the device in bytes. |
totalDiskBytes |
The total space for user data storage in the device in bytes. |
DiskVolume
Information for disk volumes
JSON representation |
---|
{ "volumeId": string, "storageFreeBytes": string, "storageTotalBytes": string } |
Fields | |
---|---|
volumeId |
Disk volume id. |
storageFreeBytes |
Free storage space in bytes. |
storageTotalBytes |
Total storage space in bytes. |
StorageStatusReport
Status data for storage.
JSON representation |
---|
{
"reportTime": string,
"disk": [
{
object ( |
Fields | |
---|---|
reportTime |
Output only. Timestamp of when the sample was collected on device A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
disk[] |
Output only. Reports on disk. |
DiskInfo
Status of the single storage device.
JSON representation |
---|
{ "serialNumber": string, "manufacturer": string, "model": string, "sizeBytes": string, "type": string, "health": string, "volumeIds": [ string ], "bytesReadThisSession": string, "bytesWrittenThisSession": string, "readTimeThisSession": string, "writeTimeThisSession": string, "ioTimeThisSession": string, "discardTimeThisSession": string } |
Fields | |
---|---|
serialNumber |
Output only. Disk serial number. |
manufacturer |
Output only. Disk manufacturer. |
model |
Output only. Disk model. |
sizeBytes |
Output only. Disk size. |
type |
Output only. Disk type: eMMC / NVMe / ATA / SCSI. |
health |
Output only. Disk health. |
volumeIds[] |
Output only. Disk volumes. |
bytesReadThisSession |
Output only. Number of bytes read since last boot. |
bytesWrittenThisSession |
Output only. Number of bytes written since last boot. |
readTimeThisSession |
Output only. Time spent reading from disk since last boot. A duration in seconds with up to nine fractional digits, terminated by ' |
writeTimeThisSession |
Output only. Time spent writing to disk since last boot. A duration in seconds with up to nine fractional digits, terminated by ' |
ioTimeThisSession |
Output only. Counts the time the disk and queue were busy, so unlike the fields above, parallel requests are not counted multiple times. A duration in seconds with up to nine fractional digits, terminated by ' |
discardTimeThisSession |
Output only. Time spent discarding since last boot. Discarding is writing to clear blocks which are no longer in use. Supported on kernels 4.18+. A duration in seconds with up to nine fractional digits, terminated by ' |
AudioStatusReport
Audio report.
JSON representation |
---|
{ "reportTime": string, "outputMute": boolean, "inputMute": boolean, "outputVolume": integer, "outputDevice": string, "inputGain": integer, "inputDevice": string } |
Fields | |
---|---|
reportTime |
Output only. Timestamp of when the sample was collected on device. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
outputMute |
Output only. Is active output device mute or not. |
inputMute |
Output only. Is active input device mute or not. |
outputVolume |
Output only. Active output device's volume in [0, 100]. |
outputDevice |
Output only. Active output device's name. |
inputGain |
Output only. Active input device's gain in [0, 100]. |
inputDevice |
Output only. Active input device's name. |
Methods |
|
---|---|
|
Get telemetry device. |
|
List all telemetry devices. |