Skip to content
Logic.Monitor PowerShell Module

Invoke-LMRemediationSource

Syntax

Section titled “Syntax”

Id-remediationId (Default)

Section titled “Id-remediationId (Default)”
Terminal window
Invoke-LMRemediationSource -Id <int> -RemediationId <int> [-AlertId <string>] [<CommonParameters>]

Id-remediationName

Section titled “Id-remediationName”
Terminal window
Invoke-LMRemediationSource -Id <int> -RemediationName <string> [-AlertId <string>]
 [<CommonParameters>]

Name-remediationName

Section titled “Name-remediationName”
Terminal window
Invoke-LMRemediationSource -Name <string> -RemediationName <string> [-AlertId <string>]
 [<CommonParameters>]

Name-remediationId

Section titled “Name-remediationId”
Terminal window
Invoke-LMRemediationSource -Name <string> -RemediationId <int> [-AlertId <string>]
 [<CommonParameters>]

DisplayName-remediationName

Section titled “DisplayName-remediationName”
Terminal window
Invoke-LMRemediationSource -DisplayName <string> -RemediationName <string> [-AlertId <string>]
 [<CommonParameters>]

DisplayName-remediationId

Section titled “DisplayName-remediationId”
Terminal window
Invoke-LMRemediationSource -DisplayName <string> -RemediationId <int> [-AlertId <string>]
 [<CommonParameters>]

Description

Section titled “Description”

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

Examples

Section titled “Examples”

EXAMPLE 1

Section titled “EXAMPLE 1”
Terminal window
Invoke-LMRemediationSource -Id 123 -RemediationId 456


Triggers remediation source ID 456 on host ID 123.

EXAMPLE 2

Section titled “EXAMPLE 2”
Terminal window
Invoke-LMRemediationSource -HostName "server01" -RemediationName "Restart Agent" -AlertId "A123456"


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

Parameters

Section titled “Parameters”

-AlertId

Section titled “-AlertId”

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

-DisplayName

Section titled “-DisplayName”

The host display name to run the remediation source against.

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

-Id

Section titled “-Id”

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

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

-Name

Section titled “-Name”

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

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

-RemediationId

Section titled “-RemediationId”

The remediation source ID to execute.

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

-RemediationName

Section titled “-RemediationName”

The remediation source name to execute.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: DisplayName-remediationName
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Name-remediationName
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: Id-remediationName
  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.