SCVMM 2016 UR5 で利用可能なコマンドレット (Remove-SCScriptCommand) について

スポンサーリンク
Quantum_Break

System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。

ここでは Remove-SCScriptCommand コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Remove-SCScriptCommand」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。

Remove-SCScriptCommand コマンドレット

名前

Remove-SCScriptCommand

概要

アプリケーション プロファイル、アプリケーションの展開、もしくはホスト プロファイルのスクリプト コマンドを削除します。

構文

Remove-SCScriptCommand
 [-Confirm]
 [-Force]
 [-JobGroup <Guid>]
 [-JobVariable <String>]
 [-PROTipID <Guid>]
 [-RunAsynchronously]
 -ScriptCommand <SCScriptCommand>
 [-WhatIf]
 [<CommonParameters>]

説明

Remove-SCScriptCommand コマンドレットは、アプリケーション プロファイル、アプリケーションの展開、もしくはホスト プロファイルのスクリプト コマンドを削除します。

パラメーター

-Confirm [<SwitchParameter>]

コマンドレットの実行前に確認のプロンプトを表示します。

必須false
位置named
既定値False
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-Force [<SwitchParameter>]

ユーザーの確認を求めずにコマンドを強制実行します。

必須false
位置named
既定値False
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-JobGroup <Guid>

同じジョブ グループ ID が実行される最終コマンドの直前にセットとして実行される一連のコマンド ID を指定します。

必須false
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-JobVariable <String>

ジョブの進行状況を追跡し、このパラメーターで指定された変数に格納する場合に指定します。

必須false
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-PROTipID <Guid>

このアクションにトリガーされるパフォーマンスとリソースの最適化のヒント (PRO ヒント) を指定します。このパラメーターは、PRO ヒントを監査することができます。

必須false
位置named
既定値None
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-RunAsynchronously [<SwitchParameter>]

ジョブが非同期で実行、制御がすぐにコマンド シェルに戻されるかどうかを指定します。

必須false
位置named
既定値False
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

-ScriptCommand <SCScriptCommand>

スクリプト コマンド オブジェクトを指定します。

必須true
位置named
既定値None
パイプライン入力を許可するTrue (ByValue)
ワイルドカード文字を許可するfalse

-WhatIf [<SwitchParameter>]

コマンドレットを実行する場合の挙動について表示します。コマンドレットは、実際には実行されません。

必須false
位置named
既定値False
パイプライン入力を許可するFalse
ワイルドカード文字を許可するfalse

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。

入力

出力

メモ

例 1 : 特定のアプリケーション プロファイルに関連付けられているすべてのスクリプト コマンドを削除する

コマンド
$AppProfile = Get-SCApplicationProfile -Name "SvcWebAppProfile01"
$ScriptCommand = Get-SCScriptCommand -ApplicationProfile $AppProfile
$ScriptCommand | Remove-SCScriptCommand
コマンドの説明

最初のコマンドは、アプリケーション プロファイル オブジェクト “SvcWebAppProfile01” を取得し、そのオブジェクトを $AppProfile 変数に格納します。

2 番目のコマンドは、$AppProfile に格納されているアプリケーション プロファイルのすべてのスクリプト コマンド オブジェクトを取得し、そのオブジェクトを $ScriptCommand 配列に格納します。

最後のコマンドは、パイプライン演算子を用いて、$ScriptCommand 配列に格納されている各アプリケーション プロファイルを Remove-SCScriptCommand に渡します。このコマンドは、スクリプト コマンド オブジェクトをアプリケーション プロファイル SvcWebAppProfile01 から削除します。

関連するリンク

  • Add-SCScriptCommand
  • Get-SCApplicationProfile
  • Get-SCScriptCommand
  • Invoke-SCScriptCommand
  • Set-SCScriptCommand

参考