Skip to content
Logic.Monitor PowerShell Module

Get-LMDashboard

Syntax

Section titled “Syntax”

All (Default)

Section titled “All (Default)”
Terminal window
Get-LMDashboard [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Id

Section titled “Id”
Terminal window
Get-LMDashboard [-Id <Int32>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Name

Section titled “Name”
Terminal window
Get-LMDashboard [-Name <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

GroupId

Section titled “GroupId”
Terminal window
Get-LMDashboard [-GroupId <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

GroupName

Section titled “GroupName”
Terminal window
Get-LMDashboard [-GroupName <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

SubGroups

Section titled “SubGroups”
Terminal window
Get-LMDashboard [-GroupPathSearchString <String>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Filter

Section titled “Filter”
Terminal window
Get-LMDashboard [-Filter <Object>] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

FilterWizard

Section titled “FilterWizard”
Terminal window
Get-LMDashboard [-FilterWizard] [-BatchSize <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Section titled “Description”

The Get-LMDashboard function retrieves dashboard information from LogicMonitor based on specified parameters. It supports filtering by ID, name, group information, and custom filters.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
#Retrieve a dashboard by ID
Get-LMDashboard -Id 123

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
#Retrieve dashboards by group name
Get-LMDashboard -GroupName "Production"

Parameters

Section titled “Parameters”

-Id

Section titled “-Id”

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: False

-Name

Section titled “-Name”

The 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: False

-GroupId

Section titled “-GroupId”

The 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: False

-GroupName

Section titled “-GroupName”

The 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: False

-GroupPathSearchString

Section titled “-GroupPathSearchString”

A 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: False

-Filter

Section titled “-Filter”

A 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: False

-FilterWizard

Section titled “-FilterWizard”

Switch 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: False

-BatchSize

Section titled “-BatchSize”

The 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

-ProgressAction

Section titled “-ProgressAction”
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga


Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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.