Export-LMDashboard

Syntax

Id (Default)

Export-LMDashboard [-Id <Int32>] [-PassThru] [-FilePath <String>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Name

Export-LMDashboard [-Name <String>] [-PassThru] [-FilePath <String>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

Description

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

Examples

Example 1

#Export a dashboard to a JSON file
Export-LMDashboard -Id 123 -FilePath "C:\temp"

Parameters

-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

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

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

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

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

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

None. You cannot pipe objects to this command.

Outputs

Returns LogicMonitor.Dashboard objects.

Notes

You must run Connect-LMAccount before running this command.

Related LINKS