Skip to content
Logic.Monitor PowerShell Module

Get-LMLogMessage

Syntax

Section titled “Syntax”

Range-Async (Default)

Section titled “Range-Async (Default)”
Terminal window
Get-LMLogMessage [-Query <string>] [-Range <string>] [-BatchSize <int>] [-MaxPages <int>] [-Async]
 [<CommonParameters>]

Date-Async

Section titled “Date-Async”
Terminal window
Get-LMLogMessage -StartDate <datetime> -EndDate <datetime> [-Query <string>] [-BatchSize <int>]
 [-MaxPages <int>] [-Async] [<CommonParameters>]

Date-Sync

Section titled “Date-Sync”
Terminal window
Get-LMLogMessage -StartDate <datetime> -EndDate <datetime> [-Query <string>] [-BatchSize <int>]
 [<CommonParameters>]

Range-Sync

Section titled “Range-Sync”
Terminal window
Get-LMLogMessage [-Query <string>] [-Range <string>] [-BatchSize <int>] [<CommonParameters>]

Description

Section titled “Description”

The Get-LMLogMessage function retrieves log messages from LogicMonitor based on specified time ranges or date ranges. It supports both synchronous and asynchronous queries with pagination control.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
#Retrieve logs for a specific date range
Get-LMLogMessage -StartDate (Get-Date).AddDays(-1) -EndDate (Get-Date)

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
#Retrieve logs asynchronously with a custom query
Get-LMLogMessage -Range "1hour" -Query "error" -Async

Parameters

Section titled “Parameters”

-Async

Section titled “-Async”

Switch to enable asynchronous query mode.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Range-Async
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Date-Async
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-BatchSize

Section titled “-BatchSize”

The number of results to return per request. Must be between 1 and 300. Defaults to 300.

Type: System.Int32
DefaultValue: 300
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-EndDate

Section titled “-EndDate”

The end date for retrieving log messages. Required for Date parameter sets.

Type: System.DateTime
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Date-Async
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Date-Sync
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-MaxPages

Section titled “-MaxPages”

The maximum number of pages to retrieve in async mode. Defaults to 10.

Type: System.Int32
DefaultValue: 10
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Range-Async
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Date-Async
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Query

Section titled “-Query”

A query string to filter the log messages.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Range

Section titled “-Range”

The time range for retrieving log messages. Valid values are “15min”, “30min”, “1hour”, “3hour”, “6hour”, “12hour”, “24hour”, “3day”, “7day”, “1month”. Defaults to “15min”.

Type: System.String
DefaultValue: 15min
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Range-Async
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Range-Sync
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-StartDate

Section titled “-StartDate”

The start date for retrieving log messages. Required for Date parameter sets.

Type: System.DateTime
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Date-Async
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Date-Sync
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

Section titled “CommonParameters”

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.