Skip to content
Logic.Monitor PowerShell Module

Import-LMDashboard

Syntax

Section titled “Syntax”

FilePath-GroupName

Section titled “FilePath-GroupName”
Terminal window
Import-LMDashboard -FilePath <String> -ParentGroupName <String> [-ReplaceAPITokensOnImport]
 [-APIToken <Object>] [-PrivateUserName <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

FilePath-GroupId

Section titled “FilePath-GroupId”
Terminal window
Import-LMDashboard -FilePath <String> -ParentGroupId <String> [-ReplaceAPITokensOnImport] [-APIToken <Object>]
 [-PrivateUserName <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

File-GroupName

Section titled “File-GroupName”
Terminal window
Import-LMDashboard -File <String> -ParentGroupName <String> [-ReplaceAPITokensOnImport] [-APIToken <Object>]
 [-PrivateUserName <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

File-GroupId

Section titled “File-GroupId”
Terminal window
Import-LMDashboard -File <String> -ParentGroupId <String> [-ReplaceAPITokensOnImport] [-APIToken <Object>]
 [-PrivateUserName <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Repo-GroupName

Section titled “Repo-GroupName”
Terminal window
Import-LMDashboard -GithubUserRepo <String> [-GithubAccessToken <String>] -ParentGroupName <String>
 [-ReplaceAPITokensOnImport] [-APIToken <Object>] [-PrivateUserName <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Repo-GroupId

Section titled “Repo-GroupId”
Terminal window
Import-LMDashboard -GithubUserRepo <String> [-GithubAccessToken <String>] -ParentGroupId <String>
 [-ReplaceAPITokensOnImport] [-APIToken <Object>] [-PrivateUserName <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Section titled “Description”

The Import-LMDashboard function allows you to import LogicMonitor dashboards from different sources, such as local files, GitHub repositories, or LogicMonitor dashboard groups. It supports importing dashboards in JSON format.

Examples

Section titled “Examples”

Example 1

Section titled “Example 1”
Terminal window
#Import dashboards from a directory
Import-LMDashboard -FilePath "C:\Dashboards" -ParentGroupId 12345 -ReplaceAPITokensOnImport -APIToken $apiToken

Example 2

Section titled “Example 2”
Terminal window
#Import dashboards from GitHub
Import-LMDashboard -GithubUserRepo "username/repo" -ParentGroupName "MyDashboards" -ReplaceAPITokensOnImport -APIToken $apiToken

Parameters

Section titled “Parameters”

-FilePath

Section titled “-FilePath”

Specifies the path to a local file or directory containing the JSON dashboard files to import.

Type: String
Parameter Sets: FilePath-GroupName, FilePath-GroupId
Aliases:


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

-File

Section titled “-File”

Specifies a single JSON dashboard file to import.

Type: String
Parameter Sets: File-GroupName, File-GroupId
Aliases:


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

-GithubUserRepo

Section titled “-GithubUserRepo”

Specifies the GitHub repository (in the format “username/repo”) from which to import JSON dashboard files.

Type: String
Parameter Sets: Repo-GroupName, Repo-GroupId
Aliases:


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

-GithubAccessToken

Section titled “-GithubAccessToken”

Specifies the GitHub access token for authenticated requests. Required for large repositories due to API rate limits.

Type: String
Parameter Sets: Repo-GroupName, Repo-GroupId
Aliases:


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

-ParentGroupId

Section titled “-ParentGroupId”

The ID of the parent dashboard group where imported dashboards will be placed.

Type: String
Parameter Sets: FilePath-GroupId, File-GroupId, Repo-GroupId
Aliases:


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

-ParentGroupName

Section titled “-ParentGroupName”

The name of the parent dashboard group where imported dashboards will be placed.

Type: String
Parameter Sets: FilePath-GroupName, File-GroupName, Repo-GroupName
Aliases:


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

-ReplaceAPITokensOnImport

Section titled “-ReplaceAPITokensOnImport”

Switch to replace API tokens in imported dashboards with a dynamically generated token.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:


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

-APIToken

Section titled “-APIToken”

The API token to use when replacing tokens in imported dashboards.

Type: Object
Parameter Sets: (All)
Aliases:


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

-PrivateUserName

Section titled “-PrivateUserName”

The username of dashboard owner when creating dashboard as private.

Type: String
Parameter Sets: (All)
Aliases:


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

-ProgressAction

Section titled “-ProgressAction”

Fill ProgressAction Description

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.

Inputs

Section titled “Inputs”

None. You cannot pipe objects to this command.

Section titled “None. You cannot pipe objects to this command.”

Outputs

Section titled “Outputs”

Returns imported dashboard objects.

Section titled “Returns imported dashboard objects.”

Notes

Section titled “Notes”

You must run Connect-LMAccount before running this command.

Section titled “Related LINKS”