Gets the task history for the Storefront Service.
Get-SfTask [[-TaskId] <Guid>] [-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 Storefront Service.
|Name||Description||Required?||Pipeline Input||Default Value|
|TaskId||Specifies the task identifier to be returned.||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_Sf_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_Sf_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 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.|
If the command fails, the following errors can be returned.
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.
ServiceStatusInvalidDb: 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.