Set-SCPROTip

Sets the status of a PRO tip.

Description

The Set-SCPROTip cmdlet sets the status of a Performance and Resource Optimization (PRO) tip object. This cmdlet, which is called by PRO tip implementation actions and is for use in building PRO Packs, is used by System Center Virtual Machine Manager (VMM) to update the status of a PRO tip while performing the action recommended by the PRO tip. You can use this cmdlet to manually update the status of PRO tips.

For more information about Set-SCPROTip, type: "Get-Help Set-SCPROTip -online".

Parameters

PROTipID

Required? true
Accept Pipeline Input? false
Position? named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

ActionDetails

Required? false
Accept Pipeline Input? false
Position? named
Provides a detailed description of what implementing this PRO tip will do. 

ActionDetailsOpsMgrString

Required? false
Accept Pipeline Input? false
Position? named
Specifies an array of strings used to provide translated action details text. The first element of the array should be the GUID of the Operations Manager string and the following elements should be the parameters for string formatting.

ActionScript

Required? false
Accept Pipeline Input? false
Position? named
Specifies the script that will run by implementing this PRO tip.

ActionSummary

Required? false
Accept Pipeline Input? false
Position? named
Provides a summary description of what implementing this PRO tip will do.

ActionSummaryOpsMgrString

Required? false
Accept Pipeline Input? false
Position? named
Specifies an array of strings used to provide translated action summary text. The first element of the array should be the GUID of the Operations Manager string and the following elements should be the parameters for string formatting.

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

LastError

Required? false
Accept Pipeline Input? false
Position? named
Specifies the error text of a runtime error from a PRO tip script. 

LastErrorOpsMgrString

Required? false
Accept Pipeline Input? false
Position? named
Specifies an array of strings used to provide translated error text. The first element of the array should be the GUID of the Operations Manager string and the following elements should be the parameters for string formatting.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

TipStatus

Required? false
Accept Pipeline Input? false
Position? named
Specifies the current status of a PRO tip object. 

VALID VALUE DESCRIPTION
----------- -----------
Active	The user can invoke the tip's recommended action.
Initialized The tip has been invoked; any incomplete jobs are queued.
Auto
Running	 The tip has been invoked; its jobs are running
Resolved	The implementation of the tip has completed successfully.
Failed	The implementation of the tip has failed.
Dismissed   The user has chosen to ignore the tip.
Closed

VMMServer

Required? false
Accept Pipeline Input? true (ByValue)
Position? named
Specifies a VMM server object.

Examples

1: Set the status of a PRO tip.
PS C:\> $PROTips = Get-SCPROTip
PS C:\> Set-SCPROTip -PROTipID $PROTips[0].Id -TipStatus Running
The first command gets all active PRO tip objects from the VMM database and stores the objects in the $AllPROTips object array.

The last command updates the first tip stored in $PROTips (as designated by the [0]) to the status "Running".

See Also