Skip to content

Latest commit

 

History

History
155 lines (122 loc) · 3.23 KB

File metadata and controls

155 lines (122 loc) · 3.23 KB
external help file Logic.Monitor-help.xml
Module Name Logic.Monitor
online version
schema 2.0.0

Get-LMDeviceGroupDevice

SYNOPSIS

Retrieves devices belonging to a LogicMonitor device group.

SYNTAX

Id (Default)

Get-LMDeviceGroupDevice -Id <Int32> [-Filter <Object>] [-IncludeSubGroups <Boolean>] [-BatchSize <Int32>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Name

Get-LMDeviceGroupDevice [-Name <String>] [-Filter <Object>] [-IncludeSubGroups <Boolean>] [-BatchSize <Int32>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

The Get-LMDeviceGroupDevice function retrieves all devices that belong to a specific device group. It supports retrieving devices from subgroups and can filter the results.

EXAMPLES

EXAMPLE 1

#Retrieve devices from a group by ID
Get-LMDeviceGroupDevice -Id 123

EXAMPLE 2

#Retrieve devices including subgroups
Get-LMDeviceGroupDevice -Name "Production Servers" -IncludeSubGroups $true

PARAMETERS

-Id

The ID of the device group. Required for Id parameter set.

Type: Int32
Parameter Sets: Id
Aliases:

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

-Name

The name of the device group. Required for Name 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. 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

-IncludeSubGroups

When set to true, includes devices from all subgroups of the specified group. Defaults to false.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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