- about_ProvMachineCreationSnapin
- about_Prov_Filtering
- about_providers
- Add-ProvSchemeControllerAddress
- Add-ProvSchemeMetadata
- Add-ProvSchemeScope
- Add-ProvTaskMetadata
- Get-ProvDBConnection
- Get-ProvDBSchema
- Get-ProvDBVersionChangeScript
- Get-ProvInstalledDBVersion
- Get-ProvObjectReference
- Get-ProvScheme
- Get-ProvSchemeMasterVMImageHistory
- Get-ProvScopedObject
- Get-ProvService
- Get-ProvServiceAddedCapability
- Get-ProvServiceConfigurationData
- Get-ProvServiceInstance
- Get-ProvServiceStatus
- Get-ProvTask
- Get-ProvVM
- Lock-ProvVM
- New-ProvScheme
- New-ProvVM
- Publish-ProvMasterVmImage
- Remove-ProvScheme
- Remove-ProvSchemeControllerAddress
- Remove-ProvSchemeMasterVMImageHistory
- Remove-ProvSchemeMetadata
- Remove-ProvSchemeScope
- Remove-ProvServiceConfigurationData
- Remove-ProvServiceMetadata
- Remove-ProvTask
- Remove-ProvTaskMetadata
- Remove-ProvVM
- Rename-ProvScheme
- Reset-ProvServiceGroupMembership
- Set-ProvDBConnection
- Set-ProvScheme
- Set-ProvSchemeMetadata
- Set-ProvServiceConfigurationData
- Set-ProvServiceMetadata
- Set-ProvTaskMetadata
- Stop-ProvTask
- Switch-ProvTask
- Test-ProvDBConnection
- Test-ProvSchemeNameAvailable
- Unlock-ProvScheme
- Unlock-ProvVM
Stop-ProvTask
Sep 29, 2015
Stops currently running MachineCreation Service tasks.
Syntax
Stop-ProvTask [-TaskId] <Guid> [-LoggingId <Guid>] [-AdminAddress <String>] [<CommonParameters>]
Detailed Description
Enables tasks currently running in the MachineCreation Service to be stopped. Once stopped, tasks cannot be restarted.
Parameters
-TaskId<Guid>
Specifies the identifier for the task to be stopped.
| Required? | true |
| Default Value | |
| Accept Pipeline Input? | true (ByPropertyName) |
-LoggingId<Guid>
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.
| Required? | false |
| Default Value | |
| Accept Pipeline Input? | false |
-AdminAddress<String>
Specifies the address of a XenDesktop controller the PowerShell snap-in connects to. You can provide this as a host name or an IP address.
| Required? | false |
| Default Value | Localhost. Once a value is provided by any cmdlet, this value becomes the default. |
| Accept Pipeline Input? | false |
Input Type
System.Management.Automation.PSObject Objects containing the TaskId parameter can be piped to the Stop-ProvTask command.
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 XenDesktop logs.
Examples
-------------------------- EXAMPLE 1 --------------------------
c:\PS>Get-ProvTask -active $true | Stop-ProvTask Success
Terminate all tasks currently executing on the MachineCreation Service.
-------------------------- EXAMPLE 2 --------------------------
c:\PS>Stop-ProvTask -TaskId bd52e688-e40d-4790-83de-9f7633481454 Success
Terminate the named task executing on the MachineCreation Service.
Support:
https://www.citrix.com/support
Feedback and forums:
https://discussions.citrix.com