Start-AlIpsDiagnostics
SYNOPSIS
Initiates gathering diagnostics from a disk produced by a failed IPS task.
SYNTAX
Start-AlIpsDiagnostics -ConnectorConfigId <String> -SourceDisk <String> [-Timeout <TimeSpan>]
[-DebugSettings <Hashtable>] [-ConnectionId <Guid>] [<CommonParameters>]
<!--NeedCopy-->
DESCRIPTION
The Start-AlIpsDiagnostics cmdlet collects diagnostic information from the provided source disk and stores it on the App Layering Appliance. The gathered diagnostics will be included in the package created by the Appliance’s Export Logs feature.
To run this command, you must provide:
- The platform-specific identifier for the source disk to be diagnosed (
-SourceDisk). This must be a disk created by a failed IPS task. In order for the disk to remain available after the IPS task fails, the task must be started with-DebugSettings @{PreserveCeOnError = $true}or-DebugSettings @{BreakOnError = $true} - The identifier of the connector configuration (
-ConnectorConfigId) that defines how to access the source platform environment where the disk resides. This should be the same identifier as the one used for the failed IPS task that created the disk.
EXAMPLES
Example 1
PS C:\> Start-AlIpsDiagnostics -ConnectorConfigId "063A0697-ACDF-43BB-969B-AA69F1419757" -SourceDisk "/subscriptions/abc-123-def/resourceGroups/resourceGroup1/providers/Microsoft.Compute/disks/sourceDiskAlpha"
<!--NeedCopy-->
This example collects diagnostic information for source disk "/subscriptions/abc-123-def/resourceGroups/resourceGroup1/providers/Microsoft.Compute/disks/sourceDiskAlpha" from connector with config Id "063A0697-ACDF-43BB-969B-AA69F1419757".
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-->
-ConnectorConfigId
Specifies the unique identifier (Id) of the App Layering connector configuration.
This should be the same identifier as the one used for the failed IPS task that created the disk.
This parameter is mandatory.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
-DebugSettings
Provides advanced debugging options for the Image Portability Service diagnostic operation, specified as a PowerShell hashtable (e.g., @{ Setting1 = 'Value1'; Setting2 = $True }).
Use this parameter only when directed by specific troubleshooting guides or support personnel.
Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
-SourceDisk
Specifies the platform-specific identifier, path, or name of the disk image to be diagnosed. This must be a disk created by a failed IPS task.
The required format for this value depends on the source platform defined by the associated -ConnectorConfigId.
This parameter is mandatory.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
<!--NeedCopy-->
-Timeout
Sets an optional time limit for the entire diagnostic operation. Specify the maximum duration (e.g., “02:00:00” for 2 hours, or use New-TimeSpan). If the diagnose task exceeds this time limit, it fails with a timeout error. By default, there is no time limit.
Type: TimeSpan
Parameter Sets: (All)
Aliases:
Required: False
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
None
OUTPUTS
[IpsDiagnosticsResult]
Returns a task object representing the diagnostic operation. This object contains a TaskId/WorkTicketId and can be piped to Wait-AlTask to monitor progress and await completion.
- WorkTicketId [Int64]
- Warning [String]
- WarningDetail [String]
- Error [ApplicationError]