Skip to content

New-LMAlertRule

Syntax

Terminal window
New-LMAlertRule [-Name] <String> [-Priority] <Int32> [-EscalatingChainId] <Int32>
[[-EscalationInterval] <Int32>] [[-ResourceProperties] <Hashtable>] [[-Devices] <String[]>]
[[-DeviceGroups] <String[]>] [[-DataSource] <String>] [[-DataSourceInstanceName] <String>]
[[-DataPoint] <String>] [[-SuppressAlertClear] <Boolean>] [[-SuppressAlertAckSdt] <Boolean>]
[[-LevelStr] <String>] [[-Description] <String>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]

Description

The New-LMAlertRule function creates a new alert rule in LogicMonitor.

Examples

Example 1

Terminal window
New-LMAlertRule -Name "New Rule" -Priority 100 -EscalatingChainId 456
Creates a new alert rule with specified name, priority and escalation chain.

Parameters

-Name

Specifies the name for the alert rule.

Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Priority

Specifies the priority level for the alert rule. Valid values: “High”, “Medium”, “Low”.

Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-EscalatingChainId

Specifies the ID of the escalation chain to use.

Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-EscalationInterval

Specifies the escalation interval in minutes.

Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-ResourceProperties

Specifies resource properties to filter on.

Type: Hashtable
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Devices

Specifies an array of device display names to apply the rule to.

Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DeviceGroups

Specifies an array of device group full paths to apply the rule to.

Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DataSource

Specifies the datasource name to apply the rule to.

Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DataSourceInstanceName

Specifies the instance name to apply the rule to.

Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DataPoint

Specifies the datapoint name to apply the rule to.

Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SuppressAlertClear

Indicates whether to suppress alert clear notifications.

Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-SuppressAlertAckSdt

Indicates whether to suppress alert acknowledgement and SDT notifications.

Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-LevelStr

Specifies the level string for the alert rule. Valid values: “All”, “Critical”, “Error”, “Warning”.

Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: All
Accept pipeline input: False
Accept wildcard characters: False

-Description

Specifies the description for the alert rule.

Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
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

None. You cannot pipe objects to this command.

Outputs

Returns the response from the API containing the new alert rule information.

Notes

This function requires a valid LogicMonitor API authentication.