| external help file | Logic.Monitor-help.xml |
|---|---|
| Module Name | Logic.Monitor |
| online version | |
| schema | 2.0.0 |
Retrieves report groups from LogicMonitor.
Get-LMReportGroup [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-LMReportGroup [-Id <Int32>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-LMReportGroup [-Name <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Get-LMReportGroup [-Filter <Object>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Get-LMReportGroup [-FilterWizard] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
The Get-LMReportGroup function retrieves report group configurations from LogicMonitor. It can retrieve all groups, a specific group by ID or name, or filter the results using either a filter object or the filter wizard.
#Retrieve all report groups
Get-LMReportGroup
#Retrieve a specific report group by name
Get-LMReportGroup -Name "Monthly Reports"
The ID of the specific report group to retrieve.
Type: Int32
Parameter Sets: Id
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: FalseThe name of the specific report group to retrieve.
Type: String
Parameter Sets: Name
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA filter object to apply when retrieving report groups.
Type: Object
Parameter Sets: Filter
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSwitch to enable the filter wizard for building a custom filter interactively.
Type: SwitchParameter
Parameter Sets: FilterWizard
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThe 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{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You must run Connect-LMAccount before running this command.