Get-LMDeviceGroup
Syntax
Section titled “Syntax”All (Default)
Section titled “All (Default)”Get-LMDeviceGroup [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]Get-LMDeviceGroup [-Id <Int32>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]Get-LMDeviceGroup [-Name <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]Filter
Section titled “Filter”Get-LMDeviceGroup [-Filter <Object>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]FilterWizard
Section titled “FilterWizard”Get-LMDeviceGroup [-FilterWizard] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]Description
Section titled “Description”The Get-LMDeviceGroup function retrieves device group information from a connected LogicMonitor portal. It supports retrieving groups by ID, name (including wildcards), or using custom filters.
Examples
Section titled “Examples”Example 1
Section titled “Example 1”#Retrieve all device groupsGet-LMDeviceGroupExample 2
Section titled “Example 2”#Retrieve a specific device group by name with wildcardGet-LMDeviceGroup -Name "* - Servers"Example 3
Section titled “Example 3”#Retrieve device groups using a filterGet-LMDeviceGroup -Filter @{parentId=1;disableAlerting=$false}Parameters
Section titled “Parameters”The ID of the device group to retrieve. Part of a mutually exclusive parameter set.
Type: Int32Parameter Sets: IdAliases:
Required: FalsePosition: NamedDefault value: 0Accept pipeline input: True (ByValue)Accept wildcard characters: FalseThe name of the device group to retrieve. Supports wildcard input such as ”* - Servers”. Part of a mutually exclusive parameter set.
Type: StringParameter Sets: NameAliases:
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-Filter
Section titled “-Filter”A filter object to apply when retrieving device groups. Can include multiple conditions combined as AND operations. Part of a mutually exclusive parameter set.
Type: ObjectParameter Sets: FilterAliases:
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept 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: SwitchParameterParameter Sets: FilterWizardAliases:
Required: FalsePosition: NamedDefault value: FalseAccept pipeline input: FalseAccept 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: Int32Parameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: 1000Accept pipeline input: FalseAccept wildcard characters: False-ProgressAction
Section titled “-ProgressAction”Fill ProgressAction Description
Type: ActionPreferenceParameter Sets: (All)Aliases: proga
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: FalseCommonParameters
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.
Inputs
Section titled “Inputs”System.Int32. The device group ID can be piped to this function.
Section titled “System.Int32. The device group ID can be piped to this function.”Outputs
Section titled “Outputs”Returns LogicMonitor.DeviceGroup objects.
Section titled “Returns LogicMonitor.DeviceGroup objects.”You must run Connect-LMAccount before running this command. When using filters, consult the LM API docs for allowed filter fields.