Share via

Clear-SCPROTip

  • Reference
Module:
VirtualMachineManager

Dismisses a PRO tip object that is no longer applicable.

Syntax

Clear-SCPROTip
     [-PROTip] <PROTip>
     [-VMMServer <ServerConnection>]
     [-RunAsynchronously]
     [-PROTipID <Guid>]
     [-JobVariable <String>]
     [<CommonParameters>]

Description

The Clear-SCPROTip cmdlet dismisses a Performance and Resource Optimization (PRO) tip object that is no longer applicable. You can use this cmdlet to dismiss a PRO tip if, for example, its recommended action is no longer valid or is out-of-date.

Virtual Machine Manager (VMM) dismisses some PRO tips automatically if the condition that generated the alert, and the resulting PRO tip recommended action, is no longer an issue.

Examples

Example 1: Dismiss the first active PRO tip

PS C:\> $PROTips = Get-SCPROTip
PS C:\> Clear-SCPROTip -PROTip $PROTips[0]

The first command gets all active PRO tip objects from the VMM database and stores the objects in the $PROTips object array.

The last command dismisses the first tip stored in $PROTips.

Parameters

-JobVariable

Specifies that job progress is tracked and stored in the variable named by this parameter.

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

-PROTip

Specifies a PRO tip object.

Type:PROTip
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

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

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

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

-VMMServer

Specifies a VMM server object.

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

Outputs

PROTip

This cmdlet returns a PROTip object.