Stop-ProvTask
Stops currently running Machine Creation Service tasks.
Syntax
Stop-ProvTask
[-TaskId] <Guid>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Enables tasks currently running in the Machine Creation Service to be stopped. Once stopped, tasks cannot be resumed.
Examples
EXAMPLE 1
Terminate all tasks currently executing on the Machine Creation Service.
Get-ProvTask -active $true | Stop-ProvTask
Success
EXAMPLE 2
Terminate the named task executing on the Machine Creation Service.
Stop-ProvTask -TaskId bd52e688-e40d-4790-83de-9f7633481454
Success
Parameters
-TaskId
Specifies the identifier for the task to be stopped.
| Type: | Guid |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-LoggingId
Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Objects containing the TaskId parameter can be piped to the Stop-ProvTask command.
Outputs
None
By default, this cmdlet returns no output.
Notes
If the command fails, the following errors can result.
Error Codes
InvalidWorkflow
The specified task could not be found.
InvalidWorkflowHost
The specified task is executing on a different server.
DatabaseError
An error occurred in the service while attempting a database operation.
DatabaseNotConfigured
The operation could not be completed because the database for the service is not configured.
DataStoreException
An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.
PermissionDenied
You do not have permission to execute this command.
AuthorizationError
There was a problem communicating with the Citrix Delegated Administration Service.
ConfigurationLoggingError
The operation could not be performed because of a configuration logging error.
CommunicationError
There was a problem communicating with the remote service.
DatabaseError
There was a problem communicating with the database.
ExceptionThrown
An unexpected error occurred. For more details, see the Windows event logs
on the controller or the Citrix Virtual Apps and Desktops logs.