Get-AlTaskItemDetail

SYNOPSIS

Retrieves detailed information about the work items and operational context associated with App Layering tasks or subtasks.

SYNTAX

Default (Default)

Get-AlTaskItemDetail [[-InputObject] <PSObject>] [-ConnectionId <Guid>] [<CommonParameters>]
<!--NeedCopy-->

ByTask

Get-AlTaskItemDetail [[-InputObject] <PSObject>] -WorkTicketId <Int64> [-ConnectionId <Guid>]
 [<CommonParameters>]
<!--NeedCopy-->

BySubTask

Get-AlTaskItemDetail [[-InputObject] <PSObject>] -WorkItemId <Int64> [-ConnectionId <Guid>]
 [<CommonParameters>]
<!--NeedCopy-->

DESCRIPTION

The Get-AlTaskItemDetail cmdlet retrieves detailed work item information from the connected App Layering Appliance for the specified tasks or subtasks. Each work item represents an operational component or context associated with a task, such as an IpsTaskContext containing VM and disk information, input/output data, and execution details.

This cmdlet is particularly useful for:

• Inspecting progress and state of individual work items within a task.
• Extracting operational data such as machine IDs, disk paths, or output artifacts from completed or failed tasks.
• Troubleshooting by examining error information and execution context.

You can specify the target task(s) or subtask(s) in several ways:

Using the pipeline (-InputObject parameter):

• Pipe the output object(s) directly from the relevant ‘Start-Al*’ command (e.g., $task | Get-AlTaskItemDetail).
• Pipe one or more Task IDs directly (e.g., 123, 456 | Get-AlTaskItemDetail).
• Pipe a custom object or hashtable containing a ‘TaskId’ or ‘SubTaskId’ property (TaskId/SubTaskId value can be a single ID or an array of IDs).

Using specific parameters:

• Use the -WorkTicketId (alias -TaskId) parameter to get details of all associated subtask(s) of a single, specific task by its ID.
• Use the -WorkItemId (alias -SubTaskId) parameter to get details of a single, specific subtask by its ID.

EXAMPLES

Example 1

PS C:\> Get-AlTaskItemDetail -TaskId 1114
<!--NeedCopy-->

This command gets the details of subtasks associated with the App Layering task with the ID 1114.

Example 2

PS C:\> Get-AlTaskItemDetail -SubTaskId 224
<!--NeedCopy-->

This command gets the details of the specific App Layering subtask with the ID 224.

Example 3

PS C:\> 1114, 629 | Get-AlTaskItemDetail
PS C:\> @(1114, 629) | Get-AlTaskItemDetail
<!--NeedCopy-->

Both of these commands get all associated subtask(s) with two App Layering tasks, with IDs 1114 and 629 by piping the IDs directly to the cmdlet.

Example 4

PS C:\> $exportTask = Start-AlIpsExport -ConnectorConfigId "063A0697-ACDF-43BB-969B-AA69F1419757" -SourceDisk "[DatastoreName] VMFolder/disk.vmdk" -OutputDiskName "MyExportedDisk"
PS C:\> $exportTask | Get-AlTaskItemDetail
<!--NeedCopy-->

This example first starts an export task and stores the resulting task object in the $exportTask variable. The second command then pipes this task object to Get-AlTaskItemDetail to get the details of the subtask(s) of that specific export operation.

Example 5

PS C:\> @{"TaskId" = @(1114, 629)} | Get-AlTaskItemDetail
<!--NeedCopy-->

This command gets the details of associated subtask(s) of tasks 1114 and 629 by piping a hashtable containing a TaskId key whose value is an array of the task IDs.

Example 6

PS C:\> New-Object PSObject -Property @{TaskId = @(1114, "629")} | Get-AlTaskItemDetail
<!--NeedCopy-->

Similar to the previous example, this command gets the details of associated subtask(s) of tasks 1114 and 629 by piping a custom PSObject that has a TaskId property containing an array of the IDs.

Example 7

PS C:\> New-Object PSObject -Property @{SubTaskId = 224} | Get-AlTaskItemDetail
<!--NeedCopy-->

This command gets the details of subtask 224 by piping a custom PSObject that has a SubTaskId property with the subtask’s ID.

PARAMETERS

-ConnectionId

Specifies the connection to the App Layering Appliance to use for this operation.

This is the GUID returned by Connect-AlAppliance.

If omitted, the command uses the current connection automatically if it’s the only one active. When multiple sessions are active, the GUID of the most recently used connection is used.

Type: Guid
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->

-InputObject

Accepts input via the pipeline to specify the task(s) or subtask(s) to process. This parameter offers flexibility in how targets are provided. It can process:

• Task objects output by ‘Start-Al*’ cmdlets (automatically extracts the TaskId).
• Single Task IDs (System.Int64).
• Arrays of Task IDs (System.Int64[]).
• Hashtables or PSCustomObjects containing a TaskId key/property (value can be a single Int64 ID or an array of Int64 IDs).
• Hashtables or PSCustomObjects containing a SubTaskId key/property (value should be a single Int64 ID or an array of Int64 IDs).

Refer to the examples section for detailed usage patterns.

Cannot be used with -WorkTicketId or -WorkItemId.

Type: PSObject
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
<!--NeedCopy-->

-WorkItemId

Specifies the unique identifier (WorkItemId or SubTaskId) of a single App Layering subtask to process.

This parameter cannot be used with -InputObject or -WorkTicketId.

Type: Int64
Parameter Sets: BySubTask
Aliases: SubTaskId

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->

-WorkTicketId

Specifies the unique identifier (WorkTicketId or TaskId) of a single App Layering task to process.

This parameter cannot be used with -InputObject or -WorkItemId.

Type: Int64
Parameter Sets: ByTask
Aliases: TaskId

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->

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

System.Management.Automation.PSObject

OUTPUTS

[WorkItemDetails[]] (Array)

Returns an array of task item details including current state, progress, start/end times, and any error information for the specified tasks or subtasks.

• WorkTicketId [Int64]
• WorkItemId [Int64]
• ItemId [Int64]
• ItemType [EntityType] Possible values:
  • Unknown (0)
  • Folder (1)
  • Group (2)
  • ActiveDirectoryEntity (3)
  • User (4)
  • DirectoryJunction (5)
  • ManagementAppliance (6)
  • CacheAppliance (7)
  • Layer (8)
  • LayerRevision (9)
  • OsLayer (10)
  • OsLayerRevision (11)
  • AppLayer (12)
  • AppLayerRevision (13)
  • MaintenanceSchedule (14)
  • Desktop (15)
  • UserDesktop (16)
  • InstallMachine (17)
  • Broker (18)
  • Collection (19)
  • UserDesktopCollection (20)
  • SessionHostCollection (21)
  • SessionHost (22)
  • ManagedMachine (23)
  • Image (24)
  • PlatformLayer (25)
  • PlatformLayerRevision (26)
  • Recipe (27)
  • Appliance (28)
  • PlatformType (29)
  • HypervisorPlatformType (30)
  • ProvisioningPlatformType (31)
  • BrokerPlatformType (32)
  • ZombieLayerRevision (33)
  • RemoteFileShare (34)
  • RemoteFileShareTable (35)
  • ImportExportFileShare (36)
  • UserRole (37)
  • UserRight (38)
  • FileShare (39)
  • WorkItem (40)
  • ConnectorCachedLayer (41)
  • LayerRepository (42)
  • ConnectorCachedCeBootImage (43)
  • ConnectorCachedDisk (44)
  • Configuration (45)
  • IpsTaskContext (46)
• ItemName [String]
• StartTime [Nullable<DateTime>]
• EndTime [Nullable<DateTime>]
• Status [WorkItemState] Possible values:
  • NotStarted (0)
  • Pending (1)
  • Running (2)
  • Complete (3)
  • Stalled (4)
  • Canceling (5)
  • Canceled (6)
  • Failed (7)
  • ActionRequired (8)
  • DoneWithErrors (9)
• ItemDetails [Object]

NOTES

RELATED LINKS

• Connect-AlAppliance