fleet/schema/tables/orbit_info.yml
Lucas Manuel Rodriguez 4784217b57
Add documentation for missing fleetd tables and regenerate JSON (#9960)
Updating documentation of Fleetd tables as part of the oncall duty.

Updating the json used by Fleet using the following command:
```sh
cd website
 ./node_modules/sails/bin/sails.js run generate-merged-schema
```

Samples:
![Screenshot 2023-02-20 at 17 20
55](https://user-images.githubusercontent.com/2073526/220192112-69a116e4-badb-4328-92d3-9a2a6f8657fe.png)
![Screenshot 2023-02-20 at 17 21
09](https://user-images.githubusercontent.com/2073526/220192117-dfa06c69-2166-47d4-99c3-e108911e2084.png)


@mikermcneil @eashaw: `generate-merged-schema` generates a different
output every time it's executed. Guess: It seems it should sort the
output lexicograhically?
2023-02-22 16:05:36 -03:00

38 lines
1.3 KiB
YAML

name: orbit_info
platforms:
- darwin
- linux
- windows
description: Returns information about the orbit instance.
columns:
- name: version
type: text
required: false
description: Version of the orbit instance.
- name: device_auth_token
type: text
required: false
description: Current Fleet Desktop token in the instance.
- name: enrolled
type: text
required: false
description: Returns whether the Orbit instance is enrolled to Fleet (true/false).
- name: last_recorded_error
type: text
required: false
description: Last recorded error in Orbit.
- name: orbit_channel
type: text
required: false
description: The Update Framework update channel used for the orbit executable.
- name: osqueryd_channel
type: text
required: false
description: The Update Framework update channel used for the osqueryd executable.
- name: desktop_channel
type: text
required: false
description: The Update Framework update channel used for the Fleet Desktop executable.
notes: This table is not a core osquery table. It is included as part of [Fleetd](https://fleetdm.com/docs/using-fleet/orbit), the osquery manager from Fleet. Fleetd can be built with [fleetctl](https://fleetdm.com/docs/using-fleet/adding-hosts#osquery-installer).
evented: false