Skip to content
Logic.Monitor PowerShell Module

Get-LMReportExecutionTask

Syntax

ReportId (Default)

Terminal window
Get-LMReportExecutionTask -ReportId <Int32> -TaskId <String> [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

ReportName

Terminal window
Get-LMReportExecutionTask -ReportName <String> -TaskId <String> [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Description

Get-LMReportExecutionTask fetches information about a previously triggered report execution task. Supply the report identifier (ID or name) along with the task ID returned from Invoke-LMReportExecution to check completion status or retrieve the result URL.

Examples

Example 1

Terminal window
Invoke-LMReportExecution -Id 42 | Select-Object -ExpandProperty taskId | Get-LMReportExecutionTask -ReportId 42

Gets the execution status for the specified report/task combination.

Example 2

Terminal window
$task = Invoke-LMReportExecution -Name "Monthly Availability"
Get-LMReportExecutionTask -ReportName "Monthly Availability" -TaskId $task.taskId

Checks the task status for the report by name.

Parameters

-ReportId

The ID of the report whose execution task should be retrieved.

Type: Int32
Parameter Sets: ReportId
Aliases:


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

-ReportName

The name of the report whose execution task should be retrieved.

Type: String
Parameter Sets: ReportName
Aliases:


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

-TaskId

The execution task identifier returned when the report was triggered.

Type: String
Parameter Sets: (All)
Aliases:


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

-ProgressAction

Fill ProgressAction Description

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga


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

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

Outputs

Notes

You must run Connect-LMAccount before running this command.