Remove-LMUptimeDevice
Syntax
Section titled “Syntax”Id (Default)
Section titled “Id (Default)”Remove-LMUptimeDevice -Id <Int32> [-HardDelete <Boolean>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]Remove-LMUptimeDevice -Name <String> [-HardDelete <Boolean>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
Section titled “Description”The Remove-LMUptimeDevice cmdlet deletes an Uptime monitor (web or ping) from LogicMonitor via the v3 device endpoint. It accepts either the numerical identifier or resolves the identifier from a device name, and submits a DELETE request with the required X-Version header.
Examples
Section titled “Examples”Example 1
Section titled “Example 1”Remove-LMUptimeDevice -Id 42Removes the Uptime device with ID 42.
Example 2
Section titled “Example 2”Remove-LMUptimeDevice -Name "web-int-01"Resolves the device ID by name and removes the corresponding Uptime device.
Parameters
Section titled “Parameters”Specifies the device identifier to remove. Accepts pipeline input by property name.
Type: Int32Parameter Sets: IdAliases:
Required: TruePosition: NamedDefault value: 0Accept pipeline input: True (ByPropertyName)Accept wildcard characters: FalseSpecifies the device name to remove. The cmdlet resolves the device and then removes it.
Type: StringParameter Sets: NameAliases:
Required: TruePosition: NamedDefault value: NoneAccept pipeline input: FalseAccept wildcard characters: False-HardDelete
Section titled “-HardDelete”Indicates whether to permanently delete the device. When $false (default), the device is moved to the recycle bin.
Type: BooleanParameter Sets: (All)Aliases:
Required: FalsePosition: NamedDefault value: FalseAccept 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”Outputs
Section titled “Outputs”System.Management.Automation.PSCustomObject
Section titled “System.Management.Automation.PSCustomObject”You must run Connect-LMAccount before invoking this cmdlet.