Skip to content
Logic.Monitor PowerShell Module

Export-LMDashboard

Syntax

Section titled “Syntax”

Id (Default)

Section titled “Id (Default)”
Terminal window
Export-LMDashboard [-Id <Int32>] [-PassThru] [-FilePath <String>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Name

Section titled “Name”
Terminal window
Export-LMDashboard [-Name <String>] [-PassThru] [-FilePath <String>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Description

Section titled “Description”

The Export-LMDashboard function exports dashboard information from LogicMonitor to a JSON file.

Examples

Section titled “Examples”

Example 1

Section titled “Example 1”
Terminal window
#Export a dashboard to a JSON file
Export-LMDashboard -Id 123 -FilePath "C:\temp"

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

-PassThru

Section titled “-PassThru”

Switch to return the dashboard export as a PSCustomObject.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:


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

-FilePath

Section titled “-FilePath”

The path to the output file.

Type: String
Parameter Sets: (All)
Aliases:


Required: False
Position: Named
Default value: (Get-Location).Path
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 LogicMonitor.Dashboard objects.

Section titled “Returns LogicMonitor.Dashboard objects.”

Notes

Section titled “Notes”

You must run Connect-LMAccount before running this command.

Section titled “Related LINKS”