Remove-LMDashboardWidget
Syntax
Section titled “Syntax”Id (Default)
Section titled “Id (Default)”Remove-LMDashboardWidget -Id <Int32> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]Remove-LMDashboardWidget -Name <String> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
Section titled “Description”The Remove-LMDashboardWidget function removes a dashboard widget from Logic Monitor. It can remove a widget either by its ID or by its name.
Examples
Section titled “Examples”Example 1
Section titled “Example 1”Remove-LMDashboardWidget -Id 123Removes the dashboard widget with ID 123.Example 2
Section titled “Example 2”Remove-LMDashboardWidget -Name "Widget Name"Removes the dashboard widget with the specified name.Parameters
Section titled “Parameters”The ID of the widget to be removed. This parameter is mandatory when using the ‘Id’ parameter set.
Type: Int32Parameter Sets: IdAliases:
Required: TruePosition: NamedDefault value: 0Accept pipeline input: True (ByPropertyName)Accept wildcard characters: FalseThe name of the widget to be removed. This parameter is mandatory when using the ‘Name’ parameter set.
Type: StringParameter Sets: NameAliases:
Required: TruePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-WhatIf
Section titled “-WhatIf”Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameterParameter Sets: (All)Aliases: wi
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-Confirm
Section titled “-Confirm”Prompts you for confirmation before running the cmdlet.
Type: SwitchParameterParameter Sets: (All)Aliases: cf
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-ProgressAction
Section titled “-ProgressAction”Fill ProgressAction Description
Type: ActionPreferenceParameter Sets: (All)Aliases: proga
Required: FalsePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: FalseCommonParameters
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”You can pipe objects to this function.
Section titled “You can pipe objects to this function.”Outputs
Section titled “Outputs”Returns a PSCustomObject containing the ID of the removed widget and a message indicating the success of the removal operation.
Section titled “Returns a PSCustomObject containing the ID of the removed widget and a message indicating the success of the removal operation.”This function requires a valid API authentication to Logic Monitor. Make sure to log in using Connect-LMAccount before running this command.