Actions63
- Account Actions
- Auto-Scale Profile Actions
- Backup Actions
- Cost Estimator Actions
- Desktop Image Actions
- Group Actions
- Host Actions
- Host Pool Actions
- Job Actions
- Network Actions
- Recovery Vault Actions
- Reservation Actions
- Resource Group Actions
- Schedule Actions
- Scripted Action Actions
- Secure Variable Actions
- Storage Actions
- Test Actions
- User Actions
- User Session Actions
Host Pool → Stop
AI-generatedSummary
Initiates a stop job for all hosts within a specified Nerdio host pool.
Inputs
- accountId (required) — The account to operate on. Choose from the list, or specify an ID using an expression.
- hostPoolId (required) — The host pool to operate on. Choose from the list, or specify an ID using an expression.
- waitForCompletion — Whether to wait for the job to complete before returning. Defaults to true.
- maxWaitSeconds — Maximum time to wait for job completion in seconds. Defaults to 300.
Output shape
The job response, or the completed job details if 'Wait for Completion' is enabled.
Returns a single record containing the initial job ID and status. If 'Wait for Completion' is true, returns the fully completed job object, which includes its final status, error messages (if any), and completion time.
Examples
Example 1: Stop a host pool and wait for the operation to finish
Select an account and host pool, ensure 'Wait for Completion' is checked, and optionally adjust 'Max Wait Time' if the pool has many hosts.
Example 2: Trigger a stop job and poll for completion later
Leave 'Wait for Completion' unchecked to get the job ID immediately, then use a 'Job' resource node to monitor status.