list_sessions
Retrieve active user sessions in Horizon VDI with filterable fields like user, pool, machine, client, and state. Use pagination and sorting to locate specific sessions for monitoring or help desk actions.
Instructions
List active user sessions in the environment.
Common filter fields: user_name, desktop_pool_id, machine_name, client_name, state. Session states: CONNECTED, DISCONNECTED, PENDING.
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":"<id>"} or {"type":"Equals","name":"user_name","value":"jsmith"} | |
| sort_by | No | Field to sort by, e.g. user_name, start_time | |
| order_by | No | Sort direction: ASC or DESC |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |