machine_action
Perform bulk actions on Horizon VDI machines, including shutdown, restart, reset, rebuild, recover, maintenance mode changes, and archive.
Instructions
Perform a bulk action on one or more machines.
Actions:
shutdown: gracefully power off (use force=true to override active sessions)
restart: reboot the machine (use force=true to override active sessions)
reset: hard reset (power cycle) — may cause data loss
rebuild: re-provision the machine from the pool's image
recover: recover a machine stuck in an error state
enter_maintenance: put machine into maintenance mode (prevents new sessions)
exit_maintenance: take machine out of maintenance mode
archive: initiate machine archival
CAUTION: rebuild and reset are destructive and will discard unsaved user data. Always confirm with the user before calling these actions.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| force | No | Force the operation even if sessions are active. Only applies to shutdown and restart — raises an error for other actions. | |
| action | Yes | Action to perform on the machines | |
| confirm | No | Only used when the server runs with HORIZON_CONFIRMATION=flag (clients without elicitation). Otherwise the user is asked to confirm directly in the client. | |
| machine_ids | Yes | List of machine IDs to act on |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||