Gets the task history for the AppLibrary Service.
Get-AppLibTask [[-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>]
Returns a list of tasks that have run or are currently running within the AppLibrary Service.
|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||Gets records with matching metadata entries.|
|The value being compared with is a concatenation of the key name, a colon, and the value. For example: -Metadata "abc:x*" matches records with a metadata entry having a key name of "abc" and a value starting with the letter "x".||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||See about_AppLib_Filtering for details.||false||false||false|
|MaxRecordCount||See about_AppLib_Filtering for details.||false||false||false|
|Skip||See about_AppLib_Filtering for details.||false||false||0|
|SortBy||See about_AppLib_Filtering for details.||false||false|
|Filter||See about_AppLib_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 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 that the PowerShell snap-in connects 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.|
If the command fails, the following errors can result. Error Codes ----------- 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 XenDesktop logs.
c:\PS>Get-AppLibTask -Active $false TaskId : cfe5b3a2-c471-443e-b05e-8658e672d10f Type : MyTask Host : NYSERVER Status : Finished CurrentOperation : TaskProgress : 100 TaskExpectedCompletion : 10/10/2012 15:28:12 LastUpdateTime : 10/10/2012 15:28:12 ActiveElapsedTime : 56 DateFinished : 10/10/2012 15:28:12 TerminatingError : ...
Get all completed tasks for the AppLibrary Service. All tasks will publish at least the fields listed above, plus more related to the particular task being performed.