Modifier

Set-InsightsCapabilityAction

  • Reference
Module:
SystemInsights

Sets a remediation action that is tied to a prediction result.

Syntax

Set-InsightsCapabilityAction
   [-Name] <String>
   [-Type] <PredictionStatus>
   [-Action] <String>
   [-ActionCredential] <PSCredential>
   [[-ComputerName] <String>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-InsightsCapabilityAction cmdlet sets a remediation action that is tied to a prediction result.

Important

Some information relates to prereleased product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Examples

Example 1

PS C:\> $Cred = Get-Credential
PS C:\> Set-InsightsCapabilityAction -Name "CPU capacity forecasting" -Type Critical -Action "C:\Users\Public\CriticalAction.ps1" -ActionCredential $Cred

This example sets a Critical action for the CPU capacity forecasting capability, using the credentials specified using the Get-Credential cmdlet.

Example 2

PS C:\> $Cred = Get-Credential
PS C:\> Set-InsightsCapabilityAction -Name "CPU capacity forecasting" -Type Warning -Action "C:\Users\Public\WarningAction.ps1" -ActionCredential $Cred

This example sets a Warning action for the CPU capacity forecasting capability, using the credentials specified using the Get-Credential cmdlet.

Parameters

-Action

Specifies the path of a PowerShell script, as well as any arguments, to be run if the capability outputs the associated prediction status.

Type:String
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ActionCredential

Specifies the credential used to run the action.

Type:PSCredential
Position:4
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

Specifies a fully qualified domain name (FQDN). If not specified, uses the local computer.

Type:String
Aliases:CN
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Specifies the credential for accessing the computer specified by the -ComputerName parameter.

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

-Name

Specifies a capability using a capability name.

Type:String
Aliases:N
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Type

Specifies the prediction status of the capability. If the capability outputs this status, the action associated with this status will be automatically invoked.

Type:PredictionStatus
Accepted values:None, Ok, Warning, Error, Critical
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.SystemInsights.Management.PowerShell.Capability

You can use the pipeline operator to pass a capability object to the Name parameter.

Outputs

None