Citrix Virtual Apps and Desktops SDK

Get-Envtesttask

August 3, 2023

Contributed by:

Gets one or more EnvTestTask(s)

Syntax

Get-EnvTestTask [-TaskId <Guid>] [-List] [-BearerToken <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Returns either the current task, a specified task, or list of tasks that are currently known to the EnvTest Service.

Parameters

Name	Description	Required?	Pipeline Input	Default Value
TaskId	Specifies the task identifier to be returned. This value can be retrieved from an existing task’s $task.TaskId property.	false	false
List	List all running tasks, including the current one.	false	false	false
BearerToken	Specifies the bearer token assigned to the calling user	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

Return Values

Citrix.Envtest.Sdk.Envtesttask

A description of a previously started task.

Examples

Example 1

$currentTask = Get-EnvTestTask
<!--NeedCopy-->

Description

Retrieve the current task. The current task is the most recently created task unless Switch-EnvTestTask explicitly changes it.

Example 2

$taskOfSpecificId = Get-EnvTestTask -TaskId 36C0EC52-2039-4D6E-B690-9F02F8CEFFCC
<!--NeedCopy-->

Description

Retrieve a fresh copy of a task object based on a known task id, which is always a Guid. This id can be retrieved from an existing task object via its $task.TaskId property.

Example 3

$allKnownTasks = Get-EnvTestTask -List
<!--NeedCopy-->

Description

Retrieve the list of current tasks. This list includes any task started by the Start-EnvTestTask cmdlet since the service started that has not later been removed via Remove-EnvTestTask.

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

Get-Envtesttask

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

Get-Envtesttask

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Return Values

Citrix.Envtest.Sdk.Envtesttask

Examples

Example 1

Description

Example 2

Description

Example 3

Description

In this article