280 lines
16 KiB
HTML
280 lines
16 KiB
HTML
<html><body>
|
|
<style>
|
|
|
|
body, h1, h2, h3, div, span, p, pre, a {
|
|
margin: 0;
|
|
padding: 0;
|
|
border: 0;
|
|
font-weight: inherit;
|
|
font-style: inherit;
|
|
font-size: 100%;
|
|
font-family: inherit;
|
|
vertical-align: baseline;
|
|
}
|
|
|
|
body {
|
|
font-size: 13px;
|
|
padding: 1em;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 26px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h2 {
|
|
font-size: 24px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h3 {
|
|
font-size: 20px;
|
|
margin-bottom: 1em;
|
|
margin-top: 1em;
|
|
}
|
|
|
|
pre, code {
|
|
line-height: 1.5;
|
|
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
|
}
|
|
|
|
pre {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
h1, h2, h3, p {
|
|
font-family: Arial, sans serif;
|
|
}
|
|
|
|
h1, h2, h3 {
|
|
border-bottom: solid #CCC 1px;
|
|
}
|
|
|
|
.toc_element {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
.firstline {
|
|
margin-left: 2 em;
|
|
}
|
|
|
|
.method {
|
|
margin-top: 1em;
|
|
border: solid 1px #CCC;
|
|
padding: 1em;
|
|
background: #EEE;
|
|
}
|
|
|
|
.details {
|
|
font-weight: bold;
|
|
font-size: 14px;
|
|
}
|
|
|
|
</style>
|
|
|
|
<h1><a href="chromemanagement_v1.html">Chrome Management API</a> . <a href="chromemanagement_v1.customers.html">customers</a> . <a href="chromemanagement_v1.customers.telemetry.html">telemetry</a> . <a href="chromemanagement_v1.customers.telemetry.devices.html">devices</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="#close">close()</a></code></p>
|
|
<p class="firstline">Close httplib2 connections.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">List all telemetry devices.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
|
|
<p class="firstline">Retrieves the next page of results.</p>
|
|
<h3>Method Details</h3>
|
|
<div class="method">
|
|
<code class="details" id="close">close()</code>
|
|
<pre>Close httplib2 connections.</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)</code>
|
|
<pre>List all telemetry devices.
|
|
|
|
Args:
|
|
parent: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required)
|
|
filter: string, Optional. Only include resources that match the filter. Supported filter fields: - org_unit_id - serial_number
|
|
pageSize: integer, Maximum number of results to return. Maximum and default are 100.
|
|
pageToken: string, Token to specify next page in the list.
|
|
readMask: string, Required. Read mask to specify which fields to return.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{
|
|
"devices": [ # Telemetry devices returned in the response.
|
|
{ # Telemetry data collected from a managed device.
|
|
"batteryInfo": [ # Output only. Information on battery specs for the device.
|
|
{ # Battery info
|
|
"designCapacity": "A String", # Output only. Design capacity (mAmpere-hours).
|
|
"designMinVoltage": 42, # Output only. Designed minimum output voltage (mV)
|
|
"manufactureDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Output only. The date the battery was manufactured.
|
|
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
|
|
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
|
|
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
|
|
},
|
|
"manufacturer": "A String", # Output only. Battery manufacturer.
|
|
"serialNumber": "A String", # Output only. Battery serial number.
|
|
"technology": "A String", # Output only. Technology of the battery. Example: Li-ion
|
|
},
|
|
],
|
|
"batteryStatusReport": [ # Output only. Battery reports collected periodically.
|
|
{ # Status data for battery.
|
|
"batteryHealth": "A String", # Output only. Battery health.
|
|
"cycleCount": 42, # Output only. Cycle count.
|
|
"fullChargeCapacity": "A String", # Output only. Full charge capacity (mAmpere-hours).
|
|
"reportTime": "A String", # Output only. Timestamp of when the sample was collected on device
|
|
"sample": [ # Output only. Sampling data for the battery.
|
|
{ # Sampling data for battery.
|
|
"chargeRate": 42, # Output only. Battery charge percentage.
|
|
"current": "A String", # Output only. Battery current (mA).
|
|
"dischargeRate": 42, # Output only. The battery discharge rate measured in mW. Positive if the battery is being discharged, negative if it's being charged.
|
|
"remainingCapacity": "A String", # Output only. Battery remaining capacity (mAmpere-hours).
|
|
"reportTime": "A String", # Output only. Timestamp of when the sample was collected on device
|
|
"status": "A String", # Output only. Battery status read from sysfs. Example: Discharging
|
|
"temperature": 42, # Output only. Temperature in Celsius degrees.
|
|
"voltage": "A String", # Output only. Battery voltage (millivolt).
|
|
},
|
|
],
|
|
"serialNumber": "A String", # Output only. Battery serial number.
|
|
},
|
|
],
|
|
"cpuInfo": [ # Output only. Information regarding CPU specs for the device.
|
|
{ # CPU specs for a CPU.
|
|
"architecture": "A String", # Output only. The CPU architecture.
|
|
"maxClockSpeed": 42, # Output only. The max CPU clock speed in kHz.
|
|
"model": "A String", # Output only. The CPU model name. Example: Intel(R) Core(TM) i5-8250U CPU @ 1.60GHz
|
|
},
|
|
],
|
|
"cpuStatusReport": [ # Output only. CPU status reports collected periodically.
|
|
{ # Contains samples of the cpu status reports.
|
|
"cpuTemperatureInfo": [ # Output only. CPU temperature sample info per CPU core in Celsius
|
|
{ # CPU temperature of a device. Sampled per CPU core in Celsius
|
|
"label": "A String", # Output only. CPU label. Example: Core 0
|
|
"temperatureCelsius": 42, # Output only. CPU temperature in Celsius.
|
|
},
|
|
],
|
|
"cpuUtilizationPct": 42, # Output only. Sample of CPU utilization (0-100 percent).
|
|
"reportTime": "A String", # Output only. The timestamp in milliseconds representing time at which this report was sampled.
|
|
"sampleFrequency": "A String", # Output only. Frequency the report is sampled.
|
|
},
|
|
],
|
|
"customer": "A String", # Output only. Google Workspace Customer whose enterprise enrolled the device.
|
|
"deviceId": "A String", # 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 Chrome OS Devices tab
|
|
"graphicsInfo": { # Information of the graphics subsystem. # Output only. Contains information regarding Graphic peripherals for the device.
|
|
"adapterInfo": { # Information of a graphics adapter (GPU). # Output only. Information about the graphics adapter (GPU).
|
|
"adapter": "A String", # Output only. Adapter name. Example: Mesa DRI Intel(R) UHD Graphics 620 (Kabylake GT2).
|
|
"deviceId": "A String", # Output only. Represents the graphics card device id.
|
|
"driverVersion": "A String", # Output only. Version of the GPU driver.
|
|
},
|
|
},
|
|
"graphicsStatusReport": [ # Output only. Graphics reports collected periodically.
|
|
{ # Information of the graphics subsystem.
|
|
"displays": [ # Output only. Information about the displays for the device.
|
|
{ # Information for a display.
|
|
"deviceId": "A String", # Output only. Represents the graphics card device id.
|
|
"isInternal": True or False, # Output only. Indicates if display is internal or not.
|
|
"refreshRate": 42, # Output only. Refresh rate in Hz.
|
|
"resolutionHeight": 42, # Output only. Resolution height in pixels.
|
|
"resolutionWidth": 42, # Output only. Resolution width in pixels.
|
|
},
|
|
],
|
|
"reportTime": "A String", # Output only. Time at which the graphics data was reported.
|
|
},
|
|
],
|
|
"memoryInfo": { # Memory information of a device. # Output only. Information regarding memory specs for the device.
|
|
"availableRamBytes": "A String", # Output only. Amount of available RAM in bytes.
|
|
"totalRamBytes": "A String", # Output only. Total RAM in bytes.
|
|
},
|
|
"memoryStatusReport": [ # Output only. Memory status reports collected periodically.
|
|
{ # Contains samples of memory status reports.
|
|
"pageFaults": 42, # Output only. Number of page faults during this collection
|
|
"reportTime": "A String", # Output only. The timestamp in milliseconds representing time at which this report was sampled.
|
|
"sampleFrequency": "A String", # Output only. Frequency the report is sampled.
|
|
"systemRamFreeBytes": "A String", # Output only. Amount of free RAM in bytes (unreliable due to Garbage Collection).
|
|
},
|
|
],
|
|
"name": "A String", # Output only. Resource name of the device.
|
|
"networkStatusReport": [ # Output only. Network specs collected periodically.
|
|
{ # State of visible/configured networks.
|
|
"gatewayIpAddress": "A String", # Output only. Gateway IP address.
|
|
"lanIpAddress": "A String", # Output only. LAN IP address.
|
|
"reportTime": "A String", # Output only. Time at which the network state was reported.
|
|
"sampleFrequency": "A String", # Output only. Frequency the report is sampled.
|
|
"signalStrengthDbm": 42, # Output only. Signal strength for wireless networks measured in decibels.
|
|
},
|
|
],
|
|
"orgUnitId": "A String", # Output only. Organization unit ID of the device.
|
|
"osUpdateStatus": [ # Output only. Contains relevant information regarding ChromeOS update status.
|
|
{ # Contains information regarding the current OS update status.
|
|
"lastRebootTime": "A String", # Output only. Timestamp of the last reboot.
|
|
"lastUpdateCheckTime": "A String", # Output only. Timestamp of the last update check.
|
|
"lastUpdateTime": "A String", # Output only. Timestamp of the last successful update.
|
|
"newPlatformVersion": "A String", # 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": "A String", # Output only. New requested platform version from the pending updated kiosk app.
|
|
"updateState": "A String", # Output only. Current state of the os update.
|
|
},
|
|
],
|
|
"serialNumber": "A String", # Output only. Device serial number. This value is the same as the Admin Console's Serial Number in the Chrome OS Devices tab.
|
|
"storageInfo": { # Status data for storage. # Output only. Information of storage specs for the device.
|
|
"availableDiskBytes": "A String", # The available space for user data storage in the device in bytes.
|
|
"totalDiskBytes": "A String", # The total space for user data storage in the device in bytes.
|
|
"volume": [ # Information for disk volumes
|
|
{ # Information for disk volumes
|
|
"storageFreeBytes": "A String", # Free storage space in bytes.
|
|
"storageTotalBytes": "A String", # Total storage space in bytes.
|
|
"volumeId": "A String", # Disk volume id.
|
|
},
|
|
],
|
|
},
|
|
"storageStatusReport": [ # Output only. Storage reports collected periodically.
|
|
{ # Status data for storage.
|
|
"disk": [ # Output only. Reports on disk
|
|
{ # Status of the single storage device.
|
|
"bytesReadThisSession": "A String", # Output only. Number of bytes read since last boot.
|
|
"bytesWrittenThisSession": "A String", # Output only. Number of bytes written since last boot.
|
|
"discardTimeThisSession": "A String", # 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+.
|
|
"health": "A String", # Output only. Disk health.
|
|
"ioTimeThisSession": "A String", # Output only. Counts the time the disk and queue were busy, so unlike the fields above, parallel requests are not counted multiple times.
|
|
"manufacturer": "A String", # Output only. Disk manufacturer.
|
|
"model": "A String", # Output only. Disk model.
|
|
"readTimeThisSession": "A String", # Output only. Time spent reading from disk since last boot.
|
|
"serialNumber": "A String", # Output only. Disk serial number.
|
|
"sizeBytes": "A String", # Output only. Disk size.
|
|
"type": "A String", # Output only. Disk type: eMMC / NVMe / ATA / SCSI.
|
|
"volumeIds": [ # Output only. Disk volumes.
|
|
"A String",
|
|
],
|
|
"writeTimeThisSession": "A String", # Output only. Time spent writing to disk since last boot.
|
|
},
|
|
],
|
|
"reportTime": "A String", # Output only. Timestamp of when the sample was collected on device
|
|
},
|
|
],
|
|
},
|
|
],
|
|
"nextPageToken": "A String", # Token to specify next page in the list.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
|
|
<pre>Retrieves the next page of results.
|
|
|
|
Args:
|
|
previous_request: The request for the previous page. (required)
|
|
previous_response: The response from the request for the previous page. (required)
|
|
|
|
Returns:
|
|
A request object that you can call 'execute()' on to request the next
|
|
page. Returns None if there are no more items in the collection.
|
|
</pre>
|
|
</div>
|
|
|
|
</body></html> |