Get-EnvTestTask
Gets one or more EnvTestTask(s)
Syntax
Get-EnvTestTask
[-TaskId <Guid>]
[-List]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Returns either the current task, a specified task, or list of tasks that are currently known to the EnvTest Service.
Examples
EXAMPLE 1
Retrieve the current task. The current task is the most recently created task unless Switch-EnvTestTask explicitly changes it.
$currentTask = Get-EnvTestTask
EXAMPLE 2
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.
$taskOfSpecificId = Get-EnvTestTask -TaskId 36C0EC52-2039-4D6E-B690-9F02F8CEFFCC
EXAMPLE 3
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.
$allKnownTasks = Get-EnvTestTask -List
Parameters
-TaskId
Specifies the task identifier to be returned. This value can be retrieved from an existing task's \$task.TaskId property.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-List
List all running tasks, including the current one.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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
Citrix.EnvTest.Sdk.EnvTestTask
A description of a previously started task.