Share via

Set-SCPROTip

  • Reference
Module:
VirtualMachineManager

Sets the status of a PRO tip.

Syntax

Set-SCPROTip
   [-VMMServer <ServerConnection>]
   -PROTipID <String>
   [-TipStatus <String>]
   [-ActionSummary <String>]
   [-ActionDetails <String>]
   [-ActionScript <String>]
   [-ActionDetailsOpsMgrString <String[]>]
   [-ActionSummaryOpsMgrString <String[]>]
   [-LastErrorOpsMgrString <String[]>]
   [-LastError <String>]
   [-RunAsynchronously]
   [-JobVariable <String>]
   [<CommonParameters>]

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 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.

Examples

Example 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.

Parameters

-ActionDetails

Provides a detailed description of what implementing this PRO tip will do.

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

-ActionDetailsOpsMgrString

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.

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

-ActionScript

Specifies the script that will run by implementing this PRO tip.

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

-ActionSummary

Provides a summary description of what implementing this PRO tip will do.

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

-ActionSummaryOpsMgrString

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.

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

-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

-LastError

Specifies the error text of a runtime error from a PRO tip script.

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

-LastErrorOpsMgrString

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.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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:String
Position:Named
Default value:None
Required:True
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

-TipStatus

Specifies the current status of a PRO tip object. The acceptable values for this parameter are:

  • 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.
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMMServer

Specifies a Virtual Machine Manager (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.