Product Documentation

Remove-EnvTestTask

Nov 17, 2015

Removes from the database completed tasks for the EnvTest Service.

Syntax

Remove-EnvTestTask [-TaskId <Guid>] [-AdminAddress <String>] [<CommonParameters>]

Remove-EnvTestTask [-Task <EnvTestTask>] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Enables completed tasks that have run within the EnvTest Service to be removed from the database.

Parameters

-TaskId<Guid>

Specifies the identifier of the task to be removed, retrieveable from the $task.TaskId property.

Required? false
Default Value  
Accept Pipeline Input? false

-Task<EnvTestTask>

Specifies the task to be removed.

Required? false
Default Value  
Accept Pipeline Input? true (ByValue)

-AdminAddress<String>

Specifies the address of a XenDesktop controller the PowerShell snap-in will connect 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

Examples

-------------------------- EXAMPLE 1 --------------------------

Remove-EnvTestTask

Removes the current task from the EnvTest service.

-------------------------- EXAMPLE 2 --------------------------

Remove-EnvTestTask -TaskId 50A4139F-2B55-4A97-A1BE-20EE4E124AA3

Removes a task from the EnvTest service via its id, which is available from an existing task's $task.TaskId property.

-------------------------- EXAMPLE 3 --------------------------

$secondTask = $(Get-EnvTestTask -List)[1] 
Remove-EnvTestTask -Task $secondTask

Removes the second task in the list returned by Get-EnvTestTask -List.