| external help file | Logic.Monitor-help.xml |
|---|---|
| Module Name | Logic.Monitor |
| online version | |
| schema | 2.0.0 |
Retrieves dashboards from LogicMonitor.
Get-LMDashboard [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-LMDashboard [-Id <Int32>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-LMDashboard [-Name <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-LMDashboard [-GroupId <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Get-LMDashboard [-GroupName <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Get-LMDashboard [-GroupPathSearchString <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Get-LMDashboard [-Filter <Object>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Get-LMDashboard [-FilterWizard] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
The Get-LMDashboard function retrieves dashboard information from LogicMonitor based on specified parameters. It supports filtering by ID, name, group information, and custom filters.
#Retrieve a dashboard by ID
Get-LMDashboard -Id 123
#Retrieve dashboards by group name
Get-LMDashboard -GroupName "Production"
The ID of the dashboard 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 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 group to filter dashboards by. Part of a mutually exclusive parameter set.
Type: String
Parameter Sets: GroupId
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe name of the group to filter dashboards by. Part of a mutually exclusive parameter set.
Type: String
Parameter Sets: GroupName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA search string to filter dashboards by group path. Part of a mutually exclusive parameter set.
Type: String
Parameter Sets: SubGroups
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseA filter object to apply when retrieving dashboards. 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.