Skip to content
Logic.Monitor PowerShell Module

Invoke-LMDiagnosticSource

Syntax

Section titled “Syntax”

Id-diagnosticId (Default)

Section titled “Id-diagnosticId (Default)”
Terminal window
Invoke-LMDiagnosticSource -Id <int> -DiagnosticId <int> [-AlertId <string>] [<CommonParameters>]

Id-diagnosticName

Section titled “Id-diagnosticName”
Terminal window
Invoke-LMDiagnosticSource -Id <int> -DiagnosticName <string> [-AlertId <string>]
 [<CommonParameters>]

Name-diagnosticName

Section titled “Name-diagnosticName”
Terminal window
Invoke-LMDiagnosticSource -Name <string> -DiagnosticName <string> [-AlertId <string>]
 [<CommonParameters>]

Name-diagnosticId

Section titled “Name-diagnosticId”
Terminal window
Invoke-LMDiagnosticSource -Name <string> -DiagnosticId <int> [-AlertId <string>]
 [<CommonParameters>]

DisplayName-diagnosticName

Section titled “DisplayName-diagnosticName”
Terminal window
Invoke-LMDiagnosticSource -DisplayName <string> -DiagnosticName <string> [-AlertId <string>]
 [<CommonParameters>]

DisplayName-diagnosticId

Section titled “DisplayName-diagnosticId”
Terminal window
Invoke-LMDiagnosticSource -DisplayName <string> -DiagnosticId <int> [-AlertId <string>]
 [<CommonParameters>]

Description

Section titled “Description”

The Invoke-LMDiagnosticSource function manually triggers a diagnostic source execution for a LogicMonitor host. The host can be identified by ID, name, or display name, and the diagnostic source can be identified by ID or name.

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
Invoke-LMDiagnosticSource -Id 123 -DiagnosticId 456


Triggers diagnostic source ID 456 on host ID 123.

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
Invoke-LMDiagnosticSource -HostName "server01" -DiagnosticName "Disk Troubleshooter" -AlertId "A123456"


Looks up host and diagnostic source by name, then triggers a diagnostic execution associated with alert A123456.

Parameters

Section titled “Parameters”

-AlertId

Section titled “-AlertId”

Optional alert ID associated with this diagnostic 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: ''

-DiagnosticId

Section titled “-DiagnosticId”

The diagnostic source ID to execute.

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

-DiagnosticName

Section titled “-DiagnosticName”

The diagnostic source name to execute.

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

-DisplayName

Section titled “-DisplayName”

The host display name to run the diagnostic source against.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases:
- HostDisplayName
- DeviceDisplayName
ParameterSets:
- Name: DisplayName-diagnosticName
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: DisplayName-diagnosticId
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Id

Section titled “-Id”

The host ID to run the diagnostic source against. Alias: HostId.

Type: System.Int32
DefaultValue: 0
SupportsWildcards: false
Aliases:
- HostId
- DeviceId
ParameterSets:
- Name: Id-diagnosticName
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
- Name: Id-diagnosticId
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

Section titled “-Name”

The host name to run the diagnostic source against. Alias: HostName.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases:
- HostName
- DeviceName
ParameterSets:
- Name: Name-diagnosticName
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Name-diagnosticId
  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.