fleet/schema/tables/disk_info.yml
Scott Gress ee7e085c15
update docs about disk_info table (#28795)
for #26674 

# Checklist for submitter

- [X] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.

## Details

This PR adds text to the existing `disk_info` notes in the UI,
clarifying that in ChromeOS, the table will only return data about
removable storage media. After researching the issue and trying various
alternatives, my conclusion is that ChromeOS is purposely designed to
make it very difficult to obtain hardware information (including
internal disk space and usage) via extensions. In order to actual do
this reporting, we'd need to integrate the [Chrome Admin
API](https://developers.google.com/workspace/admin/directory/reference/rest/v1/chromeosdevices#ChromeOsDevice)
into Fleet, which requires more design and planning.
2025-05-06 15:28:07 -05:00

52 lines
1.2 KiB
YAML

name: disk_info
platforms:
- windows
- chrome
description: Retrieve basic information about the physical disks of a system.
examples: |-
```
SELECT * FROM disk_info;
```
columns:
- name: disk_size
type: bigint
description: Size of the disk.
required: false
- name: id
type: text
description: The unique identifier of the drive on the system.
required: false
- name: name
type: text
description: The label of the disk object.
required: false
- name: type
type: text
description: The interface type of the disk.
required: false
- name: partitions
platforms:
- windows
- name: disk_index
platforms:
- windows
- name: pnp_device_id
platforms:
- windows
- name: manufacturer
platforms:
- windows
- name: hardware_model
platforms:
- windows
- name: serial
platforms:
- windows
- name: description
platforms:
- windows
evented: false
notes: |-
- On ChromeOS, this table requires the [fleetd Chrome extension](https://fleetdm.com/docs/using-fleet/chromeos).
- On ChromeOS, this table will only display information about _removable_ storage media, such as USB sticks or external hard drives.
- Available for ChromeOS 91+.