Invoke-SCPROTip
Invoke-SCPROTip
Performs the action recommended by a PRO tip.
Syntax
Parameter Set: Default
Invoke-SCPROTip [-PROTip] <PROTip> [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Detailed Description
The Invoke-SCPROTip cmdlet performs the action recommended by a Performance and Resource Optimization (PRO) tip. You can use this cmdlet to manually invoke the action recommended by a PRO tip that is not set to be implemented automatically.
Parameters
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTip<PROTip>
Specifies a PRO tip object.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-PROTipID<Guid]>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- PROTip
Examples
Example 1: Invoke the first active PRO tip
The first command gets all active PRO tip objects from the VMM database and then stores the objects in the $PROTips object array.
The second command implements the suggested action for the first PRO tip stored in $PROTips, designated by [0].
PS C:\> $PROTips = Get-SCPROTip
PS C:\> Invoke-SCPROTip -PROTip $PROTips[0]