Remove-LMCollector
Syntax
Section titled “Syntax”Id (Default)
Section titled “Id (Default)”Remove-LMCollector -Id <Int32> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]Remove-LMCollector -Name <String> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]Description
Section titled “Description”The Remove-LMCollector function removes a LogicMonitor Collector based on the provided Id or Name.
Examples
Section titled “Examples”Example 1
Section titled “Example 1”Remove-LMCollector -Id 123Removes the Collector with Id 123.Example 2
Section titled “Example 2”Remove-LMCollector -Name "Collector1"Removes the Collector with Name "Collector1".Parameters
Section titled “Parameters”Specifies the Id of the Collector to remove. 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: FalseSpecifies the Name of the Collector to remove. 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 collector and a success message confirming the removal.
Section titled “Returns a PSCustomObject containing the ID of the removed collector and a success message confirming the removal.”This function requires valid API credentials to be logged in. Use Connect-LMAccount to log in before running this command.