Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Get-ProvTask

August 3, 2023
Contributed by: 
C

Gets the task history for the Machine Creation Service.

Syntax


Get-ProvTask [[-TaskId] <Guid>] [-Type <JobType>] [-Active <Boolean>] [-Metadata <String>] [-Property <String[]>] [-ReturnTotalRecordCount] [-MaxRecordCount <Int32>] [-Skip <Int32>] [-SortBy <String>] [-Filter <String>] [-FilterScope <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Returns a list of tasks that have run or are currently running on the Machine Creation Service.

Parameters

Name Description Required? Pipeline Input Default Value
TaskId Specifies the task identifier to be returned. false false  
Type Specifies the type of task to be returned. false false  
Active Specifies whether currently running tasks only or completed tasks only are returned. false false  
Metadata Specifies the metadata entry that returned tasks should contain. false false  
Property Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server. false false  
ReturnTotalRecordCount When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Prov_Filtering for details. false false False
MaxRecordCount Specifies the maximum number of records to return. false false 250
Skip Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount. false false 0
SortBy Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present. false false The default sort order is by name or unique identifier.
Filter Gets records that match a PowerShell-style filter expression. See about_Prov_Filtering for details. false false  
FilterScope Gets only results allowed by the specified scope id. false false  
BearerToken Specifies the bearer token assigned to 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 user false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress The address of a Citrix Virtual Apps and Desktops 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

System.Management.Automation.Pscustomobject

This object provides details of the task that was run and contains at least the fields listed below. The fields output order and additional fields are related to the particular task type being performed.

  • TaskId &lt;Guid&gt; The identifier for the task that was performed.

  • Active &lt;bool&gt; Indicates whether the task is still processing or is complete.

  • Host &lt;string&gt; The name of the host on which the task is running or was run.

  • DateStarted &lt;DateTime&gt; The date and time when the task was started.

  • Type &lt;Citrix.XDInterServiceTypes.JobType&gt; The type of the task.

  • Metadata &lt;Citrix.MachineCreation.Sdk.Metadata[]&gt; The list of metadata stored against the task. For new tasks this will be empty until metadata is added.

  • CurrentOperation &lt;string&gt; Operation specific phase of the overall “Running” task state.

  • TaskProgress &lt;double&gt; The progress of the task 0-100%.

  • LastUpdateTime &lt;DateTime&gt; The date and time of the last task status update.

  • ActiveElapsedTime &lt;int&gt; Number of seconds the task has taken for active execution.

  • DateFinished &lt;DateTime&gt; The date and time when the task was completed.

  • TerminatingError &lt; Citrix.Fma.Sdk.ServiceCore.CommonCmdlets.TaskterminatingError&gt; Diagnostic information if the task completely fails.

  • Status &lt;string&gt; Where in its lifecycle the task is.

  • TaskExpectedCompletion &lt;DateTime&gt; The date and time at which the task is expected to complete.

  • WorkflowStatus &lt;System.Workflow.Runtime.WorkflowStatus&gt; Indicates the status of the workflow that is used to process the task.

Notes

If the command fails, the following errors can result.

  • UnknownObject: One of the specified objects was not found.

  • PartialData: Only a subset of the available data was returned.

  • InvalidFilter: A filtering expression was supplied that could not be interpreted for this cmdlet.

  • CouldNotQueryDatabase: The query required to get the database was not defined.

  • DatabaseError: An error occurred in the service while attempting a database operation.

  • DatabaseNotConfigured: The operation could not be completed because the database for the service is not configured.

  • DataStoreException: An error occurred in the service while attempting a database operation - communication with the database failed for various reasons.

  • PermissionDenied: You do not have permission to execute this command.

  • AuthorizationError: There was a problem communicating with the Citrix Delegated Administration Service.

  • CommunicationError: There was a problem communicating with the remote service.

  • ExceptionThrown: An unexpected error occurred.

For more details, see the Windows event logs on the controller or the Citrix Virtual Apps and Desktops logs.

Examples

Example 1 


c:\PS>Get-ProvTask -Active $false

TaskId                   : cfe5b3a2-c471-443e-b05e-8658e672d10f

Active                   : False

Host                     : NYSERVER

DateStarted              : 10/10/2020 15:27:34

Type                     : DisusedImageCleanup

Metadata                 : {}

CurrentOperation         :

TaskProgress             : 100

LastUpdateTime           : 10/10/2020 15:28:12

ActiveElapsedTime        : 56

DateFinished             : 10/10/2020 15:28:12

TerminatingError         :

Status                   : Finished

TaskExpectedCompletion   : 10/10/2012 15:28:12

...

<!--NeedCopy-->

Description

Get all completed tasks for the Machine Creation Service. All tasks will publish at least the fields listed above, plus more related to the particular task being performed.

Get-ProvTask
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.