Citrix Virtual Apps and Desktops SDK

Remove-EnvTestTask

Removes from the database completed tasks for the EnvTest Service.

Syntax

Remove-EnvTestTask
      [-SkipCertificateValidation]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-EnvTestTask
      [-Task <EnvTestTask>]
      [-SkipCertificateValidation]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-EnvTestTask
      [-TaskId <Guid>]
      [-SkipCertificateValidation]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

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

Examples

EXAMPLE 1

Removes the current task from the EnvTest service.

Remove-EnvTestTask
<!--NeedCopy-->

EXAMPLE 2

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

Remove-EnvTestTask -TaskId 50A4139F-2B55-4A97-A1BE-20EE4E124AA3
<!--NeedCopy-->

EXAMPLE 3

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

$secondTask = $(Get-EnvTestTask -List)[1]
Remove-EnvTestTask -Task $secondTask
<!--NeedCopy-->

Parameters

-TaskId

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

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Task

Specifies the task to be removed.

Type: EnvTestTask
Position: Named
Default value: None
Required: False
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-SkipCertificateValidation

Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2511

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

None

You can’t pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Remove-EnvTestTask