Get-LMDevice

Syntax

All (Default)

Get-LMDevice [-Delta] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Id

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

DisplayName

Get-LMDevice [-DisplayName <String>] [-Delta] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Name

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

Filter

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

FilterWizard

Get-LMDevice [-FilterWizard] [-Delta] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Delta

Get-LMDevice [-DeltaId <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

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

Examples

Example 1

#Retrieve a device by ID
Get-LMDevice -Id 123

Example 2

#Retrieve devices with delta tracking
Get-LMDevice -Delta

Parameters

-Id

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

The display name of the device 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

The name of the device 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

A filter object to apply when retrieving devices. 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

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

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

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

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.Device objects.

Notes

You must run Connect-LMAccount before running this command.

Related LINKS