Skip to content
Logic.Monitor PowerShell Module

Invoke-LMCollectorDebugCommand

Syntax

Section titled “Syntax”

Id-Groovy

Section titled “Id-Groovy”
Terminal window
Invoke-LMCollectorDebugCommand -Id <Int32> -GroovyCommand <String> [-CommandHostName <String>]
 [-CommandWildValue <String>] [-IncludeResult] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Id-Posh

Section titled “Id-Posh”
Terminal window
Invoke-LMCollectorDebugCommand -Id <Int32> -PoshCommand <String> [-CommandHostName <String>]
 [-CommandWildValue <String>] [-IncludeResult] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Id-Debug

Section titled “Id-Debug”
Terminal window
Invoke-LMCollectorDebugCommand -Id <Int32> -DebugCommand <String> [-CommandHostName <String>]
 [-CommandWildValue <String>] [-IncludeResult] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Name-Groovy

Section titled “Name-Groovy”
Terminal window
Invoke-LMCollectorDebugCommand -Name <String> -GroovyCommand <String> [-CommandHostName <String>]
 [-CommandWildValue <String>] [-IncludeResult] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Name-Posh

Section titled “Name-Posh”
Terminal window
Invoke-LMCollectorDebugCommand -Name <String> -PoshCommand <String> [-CommandHostName <String>]
 [-CommandWildValue <String>] [-IncludeResult] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Name-Debug

Section titled “Name-Debug”
Terminal window
Invoke-LMCollectorDebugCommand -Name <String> -DebugCommand <String> [-CommandHostName <String>]
 [-CommandWildValue <String>] [-IncludeResult] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Section titled “Description”

The Invoke-LMCollectorDebugCommand function allows execution of debug, PowerShell, or Groovy commands on a specified LogicMonitor collector.

Examples

Section titled “Examples”

Example 1

Section titled “Example 1”
Terminal window
#Execute a debug command
Invoke-LMCollectorDebugCommand -Id 123 -DebugCommand "!account" -IncludeResult

Example 2

Section titled “Example 2”
Terminal window
#Execute a PowerShell command
Invoke-LMCollectorDebugCommand -Name "Collector1" -PoshCommand "Get-Process"

Parameters

Section titled “Parameters”

-Id

Section titled “-Id”

The ID of the collector. Required for Id parameter sets.

Type: Int32
Parameter Sets: Id-Groovy, Id-Posh, Id-Debug
Aliases:


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

-Name

Section titled “-Name”

The name of the collector. Required for Name parameter sets.

Type: String
Parameter Sets: Name-Groovy, Name-Posh, Name-Debug
Aliases:


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

-DebugCommand

Section titled “-DebugCommand”

The debug command to execute. Required for Debug parameter sets.

Type: String
Parameter Sets: Id-Debug, Name-Debug
Aliases:


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

-PoshCommand

Section titled “-PoshCommand”

The PowerShell command to execute. Required for Posh parameter sets.

Type: String
Parameter Sets: Id-Posh, Name-Posh
Aliases:


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

-GroovyCommand

Section titled “-GroovyCommand”

The Groovy command to execute. Required for Groovy parameter sets.

Type: String
Parameter Sets: Id-Groovy, Name-Groovy
Aliases:


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

-CommandHostName

Section titled “-CommandHostName”

The hostname context for the command execution.

Type: String
Parameter Sets: (All)
Aliases:


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

-CommandWildValue

Section titled “-CommandWildValue”

The wild value context for the command execution.

Type: String
Parameter Sets: (All)
Aliases:


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

-IncludeResult

Section titled “-IncludeResult”

Switch to wait for and include command execution results.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:


Required: False
Position: Named
Default value: False
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 command execution results if IncludeResult is specified.

Section titled “Returns command execution results if IncludeResult is specified.”

Notes

Section titled “Notes”

You must run Connect-LMAccount before running this command.

Section titled “Related LINKS”