Export (0) Print
Expand All
Expand Minimize

Set-SCPROTip

Updated: April 29, 2014

Applies To: System Center 2012 R2 Virtual Machine Manager

Set-SCPROTip

Sets the status of a PRO tip.

Syntax

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




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

Parameters

-ActionDetails<String>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ActionDetailsOpsMgrString<String[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ActionScript<String>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ActionSummary<String>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ActionSummaryOpsMgrString<String[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-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

-LastError<String>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-LastErrorOpsMgrString<String[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PROTipID<String>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.


Aliases

none

Required?

true

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

-TipStatus<String>

Specifies the current status of a PRO tip object. Valid values 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.


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.

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: Set the status of a PRO tip

The first command gets all active PRO tip objects from the VMM database, and then 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.


PS C:\> $PROTips = Get-SCPROTip
PS C:\> Set-SCPROTip -PROTipID $PROTips[0].Id -TipStatus Running

Related topics

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft