Skip to content
Logic.Monitor PowerShell Module

Get-LMService

Syntax

Section titled “Syntax”

All (Default)

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

Id

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

DisplayName

Section titled “DisplayName”
Terminal window
Get-LMService [-DisplayName <String>] [-Delta] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Name

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

Filter

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

FilterWizard

Section titled “FilterWizard”
Terminal window
Get-LMService [-FilterWizard] [-Delta] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Delta

Section titled “Delta”
Terminal window
Get-LMService [-DeltaId <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Description

Section titled “Description”

The Get-LMService function retrieves service information from LogicMonitor based on specified parameters. It can return a single service by ID or multiple services based on name, display name, filter, or filter wizard. It also supports delta tracking for monitoring changes.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
#Retrieve a service by ID
Get-LMService -Id 123

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
#Retrieve services with delta tracking
Get-LMService -Delta

Parameters

Section titled “Parameters”

-Id

Section titled “-Id”

The ID of the service 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

-DisplayName

Section titled “-DisplayName”

The display name of the service to retrieve. Part of a mutually exclusive parameter set.

Type: String
Parameter Sets: DisplayName
Aliases:


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

-Name

Section titled “-Name”

The name of the service 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 services. 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

-FilterWizard

Section titled “-FilterWizard”

Switch to use the filter wizard interface for building the filter. Part of a mutually exclusive parameter set.

Type: SwitchParameter
Parameter Sets: FilterWizard
Aliases:


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

-Delta

Section titled “-Delta”

Switch to return a deltaId along with the requested data for change tracking.

Type: SwitchParameter
Parameter Sets: All, DisplayName, Name, Filter, FilterWizard
Aliases:


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

-DeltaId

Section titled “-DeltaId”

The deltaId string for retrieving changes since a previous query.

Type: String
Parameter Sets: Delta
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”
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.