Citrix Virtual Apps and Desktops SDK

Get-ProvTask

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>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

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

Examples

EXAMPLE 1

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 -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-->

Parameters

-Type

Specifies the type of task to be returned.

Type: JobType
Accepted values: AllJobTypes, NewProvisioningScheme, NewVirtualMachine, PublishImage, RemoveVirtualMachine, ResetVMPendingDiskRemoval, DisusedImageCleanUp, VMRecreation, DiskReplication, DiskUpload, DiskCopy, ResetVMDisk, RemoveProvScheme, NewImageVersion, SetProvisioningSchemeImage, RemoveProvImageDefinition, MoveVMDisk, RemoveProvImageVersion, NewSnapshot, ResetSnapshot, RemoveSnapshot, NewProvImageVersionSpec, RemoveProvImageVersionSpec
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Active

Specifies whether currently running tasks only or completed tasks only are returned.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Metadata

Specifies the metadata entry that returned tasks should contain.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: 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.

Type: String[]
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: 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.

Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-MaxRecordCount

Specifies the maximum number of records to return.

Type: Int32
Position: Named
Default value: 250
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

Type: Int32
Position: Named
Default value: 0
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-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.

Type: String
Position: Named
Default value: The default sort order is by name or unique identifier.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Gets records that match a PowerShell-style filter expression. See about_Prov_Filtering for details.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-FilterScope

Gets only results allowed by the specified scope id.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False
Introduced in: Citrix Virtual Apps and Desktop 7 2106

-TaskId

Specifies the task identifier to be returned.

Type: Guid
Position: 2
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

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

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 <Guid>

The identifier for the task that was performed.

Active <bool>

Indicates whether the task is still processing or is complete.

Host <string>

The name of the host on which the task is running or was run.

DateStarted <DateTime>

The date and time when the task was started.

Type <Citrix.XDInterServiceTypes.JobType>

The type of the task.

Metadata <Citrix.MachineCreation.Sdk.Metadata[]>

The list of metadata stored against the task. For new tasks this will be empty until metadata is added.

CurrentOperation <string>

Operation specific phase of the overall “Running” task state.

TaskProgress <double>

The progress of the task 0-100%.

LastUpdateTime <DateTime>

The date and time of the last task status update.

ActiveElapsedTime <int>

Number of seconds the task has taken for active execution.

DateFinished <DateTime>

The date and time when the task was completed.

TerminatingError < Citrix.Fma.Sdk.ServiceCore.CommonCmdlets.TaskterminatingError>

Diagnostic information if the task completely fails.

Status <string>

Where in its lifecycle the task is.

TaskExpectedCompletion <DateTime>

The date and time at which the task is expected to complete.

WorkflowStatus <System.Workflow.Runtime.WorkflowStatus>

Indicates the status of the workflow that is used to process the task.

Notes

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 Citrix Virtual Apps and Desktops logs.

Get-ProvTask