Skip to content
Logic.Monitor PowerShell Module

Get-LMDeviceGroupDevice

Syntax

Section titled “Syntax”

Id (Default)

Section titled “Id (Default)”
Terminal window
Get-LMDeviceGroupDevice -Id <int> [-Filter <Object>] [-IncludeSubGroups <bool>] [-BatchSize <int>]
 [<CommonParameters>]

Name

Section titled “Name”
Terminal window
Get-LMDeviceGroupDevice [-Name <string>] [-Filter <Object>] [-IncludeSubGroups <bool>]
 [-BatchSize <int>] [<CommonParameters>]

Description

Section titled “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

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
#Retrieve devices from a group by ID
Get-LMDeviceGroupDevice -Id 123

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
#Retrieve devices including subgroups
Get-LMDeviceGroupDevice -Name "Production Servers" -IncludeSubGroups $true

Parameters

Section titled “Parameters”

-BatchSize

Section titled “-BatchSize”

The number of results to return per request. Must be between 1 and 1000. Defaults to 1000.

Type: System.Int32
DefaultValue: 1000
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Filter

Section titled “-Filter”

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

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Id

Section titled “-Id”

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

Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Id
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-IncludeSubGroups

Section titled “-IncludeSubGroups”

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

Type: System.Boolean
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

Section titled “-Name”

The name of the device group. Required for Name parameter set.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Name
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

Section titled “CommonParameters”

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.