Skip to content
Logic.Monitor PowerShell Module

Invoke-LMCollectorDebugCommand

Syntax

Section titled “Syntax”

Id-Groovy

Section titled “Id-Groovy”
Terminal window
Invoke-LMCollectorDebugCommand -Id <int> -GroovyCommand <string> [-CommandHostName <string>]
 [-CommandWildValue <string>] [-IncludeResult] [<CommonParameters>]

Id-Posh

Section titled “Id-Posh”
Terminal window
Invoke-LMCollectorDebugCommand -Id <int> -PoshCommand <string> [-CommandHostName <string>]
 [-CommandWildValue <string>] [-IncludeResult] [<CommonParameters>]

Id-Debug

Section titled “Id-Debug”
Terminal window
Invoke-LMCollectorDebugCommand -Id <int> -DebugCommand <string> [-CommandHostName <string>]
 [-CommandWildValue <string>] [-IncludeResult] [<CommonParameters>]

Name-Groovy

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

Name-Posh

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

Name-Debug

Section titled “Name-Debug”
Terminal window
Invoke-LMCollectorDebugCommand -Name <string> -DebugCommand <string> [-CommandHostName <string>]
 [-CommandWildValue <string>] [-IncludeResult] [<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”

-CommandHostName

Section titled “-CommandHostName”

The hostname context for the command execution.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-CommandWildValue

Section titled “-CommandWildValue”

The wild value context for the command execution.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-DebugCommand

Section titled “-DebugCommand”

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

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Name-Debug
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Id-Debug
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-GroovyCommand

Section titled “-GroovyCommand”

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

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Name-Groovy
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Id-Groovy
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Id

Section titled “-Id”

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

Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Id-Groovy
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Id-Posh
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Id-Debug
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-IncludeResult

Section titled “-IncludeResult”

Switch to wait for and include command execution results.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

Section titled “-Name”

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

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Name-Groovy
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Name-Posh
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Name-Debug
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PoshCommand

Section titled “-PoshCommand”

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

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Name-Posh
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Id-Posh
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

Section titled “CommonParameters”

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.