Skip to content
Logic.Monitor PowerShell Module

Get-LMAlertRule

Syntax

Section titled “Syntax”

All (Default)

Section titled “All (Default)”
Terminal window
Get-LMAlertRule [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Id

Section titled “Id”
Terminal window
Get-LMAlertRule [-Id <Int32>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Name

Section titled “Name”
Terminal window
Get-LMAlertRule [-Name <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Filter

Section titled “Filter”
Terminal window
Get-LMAlertRule [-Filter <Object>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Description

Section titled “Description”

The Get-LMAlertRule function retrieves alert rules from LogicMonitor based on specified criteria. It can return a single rule by ID or name, or multiple rules using filters.

Examples

Section titled “Examples”

Example 1

Section titled “Example 1”
Terminal window
#Retrieve an alert rule by ID
Get-LMAlertRule -Id 123

Example 2

Section titled “Example 2”
Terminal window
#Retrieve an alert rule by name
Get-LMAlertRule -Name "High CPU Usage"

Example 3

Section titled “Example 3”
Terminal window
#Retrieve alert rules using a filter
Get-LMAlertRule -Filter $filterObject

Parameters

Section titled “Parameters”

-Id

Section titled “-Id”

The ID of the alert rule to retrieve. Part of a mutually exclusive parameter set.

Type: Int32
Parameter Sets: Id
Aliases:


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

-Name

Section titled “-Name”

The name of the alert rule to retrieve. Part of a mutually exclusive parameter set.

Type: String
Parameter Sets: Name
Aliases:


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

-Filter

Section titled “-Filter”

A filter object to apply when retrieving alert rules. Part of a mutually exclusive parameter set.

Type: Object
Parameter Sets: Filter
Aliases:


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

-BatchSize

Section titled “-BatchSize”

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

Type: Int32
Parameter Sets: (All)
Aliases:


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

-ProgressAction

Section titled “-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

Section titled “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

Section titled “Inputs”

None. You cannot pipe objects to this command.

Section titled “None. You cannot pipe objects to this command.”

Outputs

Section titled “Outputs”

Returns LogicMonitor.AlertRule objects.

Section titled “Returns LogicMonitor.AlertRule objects.”

Notes

Section titled “Notes”

You must run Connect-LMAccount before running this command.

Section titled “Related LINKS”