Skip to content

Latest commit

 

History

History
139 lines (109 loc) · 3.06 KB

File metadata and controls

139 lines (109 loc) · 3.06 KB
external help file Logic.Monitor-help.xml
Module Name Logic.Monitor
online version
schema 2.0.0

Get-LMDeviceGroupAlert

SYNOPSIS

Retrieves alerts for a LogicMonitor device group.

SYNTAX

Id (Default)

Get-LMDeviceGroupAlert -Id <Int32> [-Filter <Object>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Name

Get-LMDeviceGroupAlert [-Name <String>] [-Filter <Object>] [-BatchSize <Int32>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

The Get-LMDeviceGroupAlert function retrieves all alerts associated with a specific device group in LogicMonitor. The device group can be identified by either ID or name, and the results can be filtered.

EXAMPLES

EXAMPLE 1

#Retrieve alerts for a device group by ID
Get-LMDeviceGroupAlert -Id 123

EXAMPLE 2

#Retrieve alerts for a device group by name with filter
Get-LMDeviceGroupAlert -Name "Production Servers" -Filter $filterObject

PARAMETERS

-Id

The ID of the device group to retrieve alerts for. This parameter is mandatory when using the Id parameter set and can accept pipeline input.

Type: Int32
Parameter Sets: Id
Aliases:

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

-Name

The name of the device group to retrieve alerts for. 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

A filter object to apply when retrieving alerts. This parameter is optional.

Type: Object
Parameter Sets: (All)
Aliases:

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

-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

{{ 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

System.Int32. The device group ID can be piped to this function.

OUTPUTS

Returns alert objects for the specified device group.

NOTES

You must run Connect-LMAccount before running this command.

RELATED LINKS