Skip to content

Commit 09a23aa

Browse files
api.md: regenerate from nasty@fc806c5
1 parent 09f894a commit 09a23aa

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

api.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ Clients should re-fetch the relevant resource when they receive an event. Event
7676
- [System TLS](#system-tls)
7777
- [System NUT (UPS)](#system-nut-ups)
7878
- [System Passthrough](#system-passthrough)
79+
- [System Guest Tools](#system-guest-tools)
7980
- [System Secure Boot](#system-secure-boot)
8081
- [System SSH](#system-ssh)
8182
- [System Tailscale](#system-tailscale)
@@ -3550,6 +3551,52 @@ Validate, persist, and regenerate the passthrough Nix snippet from a new vendor:
35503551
not significant — we sort+dedupe on save and write. |
35513552

35523553

3554+
## System Guest Tools
3555+
3556+
### `system.guest_tools.status`
3557+
3558+
Return VM guest-tools state: opt-in flag, detected hypervisor, and the live rebuild state.
3559+
3560+
**Role:** `any`
3561+
3562+
**Returns:**
3563+
3564+
| Field | Type | Required | Description |
3565+
|-------|------|:--------:|-------------|
3566+
| `enabled` | boolean | yes | Persisted opt-in flag. |
3567+
| `hypervisor` | string | yes | Hypervisor reported by `systemd-detect-virt` (e.g. `vmware`,
3568+
`microsoft`, `kvm`, `qemu`, `oracle`, `none`). |
3569+
| `is_vm` | boolean | yes | True when running under any detected hypervisor. |
3570+
| `log_tail` | string | no | Recent rebuild log lines, surfaced while running or on failure. |
3571+
| `rebuild_state` | string | yes | `idle` | `running` | `failed` — state of the most recent
3572+
guest-tools rebuild, read from the transient unit. |
3573+
3574+
3575+
### `system.guest_tools.set`
3576+
3577+
Enable/disable the per-box VM guest integrations (VMware open-vm-tools / Hyper-V), regenerate the Nix overlay, and trigger nixos-rebuild switch to apply without a reboot.
3578+
3579+
**Role:** `admin`
3580+
3581+
**Params:**
3582+
3583+
| Field | Type | Required | Description |
3584+
|-------|------|:--------:|-------------|
3585+
| `enabled` | boolean | yes | |
3586+
3587+
**Returns:**
3588+
3589+
| Field | Type | Required | Description |
3590+
|-------|------|:--------:|-------------|
3591+
| `enabled` | boolean | yes | Persisted opt-in flag. |
3592+
| `hypervisor` | string | yes | Hypervisor reported by `systemd-detect-virt` (e.g. `vmware`,
3593+
`microsoft`, `kvm`, `qemu`, `oracle`, `none`). |
3594+
| `is_vm` | boolean | yes | True when running under any detected hypervisor. |
3595+
| `log_tail` | string | no | Recent rebuild log lines, surfaced while running or on failure. |
3596+
| `rebuild_state` | string | yes | `idle` | `running` | `failed` — state of the most recent
3597+
guest-tools rebuild, read from the transient unit. |
3598+
3599+
35533600
## System Secure Boot
35543601

35553602
### `system.secure_boot.readiness`

0 commit comments

Comments
 (0)