Get-LMEventSource.md

external help file	Logic.Monitor-help.xml
Module Name	Logic.Monitor
online version
schema	2.0.0

Get-LMEventSource

SYNOPSIS

Retrieves event sources from LogicMonitor.

SYNTAX

All (Default)

Get-LMEventSource [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Id

Get-LMEventSource [-Id <Int32>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Name

Get-LMEventSource [-Name <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Filter

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

DESCRIPTION

The Get-LMEventSource function retrieves event source configurations from LogicMonitor. It can retrieve all event sources, a specific source by ID or name, or filter the results.

EXAMPLES

EXAMPLE 1

#Retrieve all event sources
Get-LMEventSource

EXAMPLE 2

#Retrieve a specific event source by name
Get-LMEventSource -Name "Windows-Events"

PARAMETERS

-Id

The ID of the specific event source to retrieve.

Type: Int32
Parameter Sets: Id
Aliases:

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

-Name

The name of the specific event source to retrieve.

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 event sources.

Type: Object
Parameter Sets: Filter
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

None. You cannot pipe objects to this command.

OUTPUTS

Returns LogicMonitor.EventSource objects.

NOTES

You must run Connect-LMAccount before running this command.

RELATED LINKS