| external help file | Logic.Monitor-help.xml |
|---|---|
| Module Name | Logic.Monitor |
| online version | |
| schema | 2.0.0 |
Retrieves dashboard groups from LogicMonitor.
Get-LMDashboardGroup [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-LMDashboardGroup [-Id <Int32>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Get-LMDashboardGroup [-Name <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Get-LMDashboardGroup [-ParentGroupId <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Get-LMDashboardGroup [-ParentGroupName <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Get-LMDashboardGroup [-Filter <Object>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Get-LMDashboardGroup [-FilterWizard] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
The Get-LMDashboardGroup function retrieves dashboard group information from LogicMonitor based on specified parameters. It can return a single dashboard group by ID or multiple groups based on name, parent group, or using filters.
#Retrieve a dashboard group by ID
Get-LMDashboardGroup -Id 123
#Retrieve dashboard groups by parent group
Get-LMDashboardGroup -ParentGroupName "Production"
The ID of the dashboard group 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: FalseThe name of the dashboard group 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: FalseThe ID of the parent group to filter results by. Part of a mutually exclusive parameter set.
Type: String
Parameter Sets: ParentId
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe name of the parent group to filter results by. Part of a mutually exclusive parameter set.
Type: String
Parameter Sets: ParentName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA filter object to apply when retrieving dashboard groups. 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: FalseSwitch 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: 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: FalseType: 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.