Citrix Virtual Apps and Desktops SDK

Switch-EnvTestTask

March 11, 2024

Contributed by:

Sets the current task that will be returned by a call to Get-EnvTestTask with no parameters.

Syntax

Switch-EnvTestTask [-TaskId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Switch-EnvTestTask [-Task <EnvTestTask>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Sets the current task that will be returned by a call to Get-EnvTestTask with no parameters.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
TaskId	Specifies the identifier of the task to be made current.	false	false
Task	The task object to be made current, retrieveable from the $task.TaskId property.	false	false
BearerToken	Specifies the bearer token assigned to the calling user	false	false
AdminClientIP	Specifies the Client IP of the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false
AdminAddress	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.	false	false	Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

System.Management.Automation.Psobject

Objects containing the TaskId parameter can be piped to the Remove-EnvTestTask command.

Return Values

Examples

Example 1

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

<!--NeedCopy-->

Description

Switches the current task to another via its id, which is available from an existing task’s $task.TaskId property.

Example 2

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

Switch-EnvTestTask -Task $switchTask

<!--NeedCopy-->

Description

Switches the current task to the second in the list returned by Get-EnvTestTask -List.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Switch-EnvTestTask

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Switch-EnvTestTask

Syntax

Detailed Description

Related Commands

Parameters

Input Type

System.Management.Automation.Psobject

Return Values

Examples

Example 1

Description

Example 2

Description

In this article