list_machines
Retrieve virtual desktop machines in Horizon, with filters for pool and power state plus pagination to handle large inventories.
Instructions
List machines (virtual desktops) in the environment.
To filter by pool, use: filter={"type":"Equals","name":"desktop_pool_id","value":""} To filter by state, use: filter={"type":"Equals","name":"state","value":"AVAILABLE"}
Returns {items, count, page, size, pages_fetched, has_more, next_page, truncated}. If has_more is true there may be more results: call again with page=next_page (or narrow the filter), or pass fetch_all=true to fetch pages automatically (stops after 10 pages or 5000 items and sets truncated=true). Never treat a result with has_more=true as the complete list.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (1-based) | |
| size | No | Results per page (max 1000) | |
| filter | No | Horizon filter JSON string. Example: {"type":"Equals","name":"desktop_pool_id","value":"<pool-id>"} | |
| sort_by | No | Field name to sort by, e.g. name | |
| order_by | No | Sort direction: ASC or DESC | |
| fetch_all | No | Fetch successive pages automatically (up to 10 pages / 5000 items). Prefer a filter when you only need a subset. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||