Set-SCPROTip
Set-SCPROTip
Sets the status of a PRO tip.
構文
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>]
詳細説明
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.
パラメーター
-ActionDetails<String>
Provides a detailed description of what implementing this PRO tip will do.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
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.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-ActionScript<String>
Specifies the script that will run by implementing this PRO tip.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-ActionSummary<String>
Provides a summary description of what implementing this PRO tip will do.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
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.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-LastError<String>
Specifies the error text of a runtime error from a PRO tip script.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
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.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-PROTipID<String>
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.
エイリアス |
none |
必須? |
true |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
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.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
True (ByValue) |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
出力
出力型は、コマンドレットによって生成されるオブジェクトの型です。
- PROTip
例
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