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

スポンサーリンク
Windows ストア限定

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

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

Invoke-SCScriptCommand コマンドレット

名前

Invoke-SCScriptCommand

概要

指定したホストでスクリプト コマンドを実行します。

構文

Invoke-SCScriptCommand
 [-CommandParameters <String>]
 -Executable <String>
 [-JobVariable <String>]
 [-LibraryResource <CustomResource>]
 [-PROTipID <Guid>]
 [-RunAsAccount <RunAsAccount>]
 [-RunAsynchronously]
 [-ScriptCommandSetting <SCScriptCommandSetting>]
 [-StandardInput <String>]
 -StorageFileServerNode <StorageFileServerNode>
 [-TimeoutSeconds <Int32>]
 [-VMMServer <ServerConnection>]
 [<CommonParameters>]

Invoke-SCScriptCommand
 [-CommandParameters <String>]
 -Executable <String>
 [-JobVariable <String>]
 [-LibraryResource <CustomResource>]
 [-PROTipID <Guid>]
 [-RunAsAccount <RunAsAccount>]
 [-RunAsynchronously]
 [-ScriptCommandSetting <SCScriptCommandSetting>]
 [-StandardInput <String>]
 [-TimeoutSeconds <Int32>]
 -VMHost <Host>
 [-VMMServer <ServerConnection>]
 [<CommonParameters>]

説明

Invoke-SCScriptCommand コマンドレットは、指定したホストでスクリプト コマンドを実行します。このコマンドレットは、Hyper-V ホストでのみサポートされます。

パラメーター

-CommandParameters <String>

スクリプト、もしくは実行可能プログラムのパラメーターを指定します。

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

-Executable <String>

実行可能プログラム名を指定します。

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

-JobVariable <String>

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

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

-LibraryResource <CustomResource>

VMM ライブラリに格納されたリソースを指定します。

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

-PROTipID <Guid>

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

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

-RunAsAccount <RunAsAccount>

このアクションを実行するためのアクセス権を持つ資格情報が含まれる Run As アカウントを指定します。

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

-RunAsynchronously [<SwitchParameter>]

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

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

-ScriptCommandSetting <SCScriptCommandSetting>

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

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

-StandardInput <String>

スクリプト コマンドで使用する標準入力情報を含むファイルへのパスを指定します。

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

-StorageFileServerNode <StorageFileServerNode>

ファイル サーバー クラスターのノードを指定します。

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

-TimeoutSeconds <Int32>

プロセスがタイムアウトするまでに待機する時間を秒単位で指定します。

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

-VMHost <Host>

仮想マシン ホスト オブジェクトを指定します。VMM は、Hyper-V ホスト、VMware ESX ホスト、および Citrix XenServer ホストをサポートします。

各ホストの種類に関する情報について、Add-SCVMHost コマンドレットを参照してください。

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

-VMMServer <ServerConnection>

VMM サーバー オブジェクトを取得します。

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

<CommonParameters>

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

入力

出力

  • ScriptCommand
    • このコマンドレットは、ScriptCommand オブジェクトを返します。

メモ

Get-SCVMHost コマンドレットを用いて取得することが可能な VMHost * オブジェクトが必要です。

例 1 : スクリプト コマンドを実行する

コマンド
$VMHost = Get-SCVMHost -ComputerName "VMHost01"
Invoke-SCScriptCommand -VMHost $VMHost -Executable "cmd.exe" -CommandParameters "/C rd C:\test" -TimeoutSeconds 60
コマンドの説明

最初のコマンドは、ホスト オブジェクト “VMHost01” を取得し、そのオブジェクトを $VMHost 変数に格納します。

2 番目のコマンドは、$VMHost に格納されているホスト上の指定されたパラメーターを用いて、cmd.exe という実行可能プログラムを実行します。この場合、Invoke-SCScriptCommand は VMHost01 上の c: ドライブから test ディレクトリを削除します。

関連するリンク

  • Add-SCScriptCommand
  • Get-SCScriptCommand
  • Get-SCVMHost
  • Remove-SCScriptCommand
  • Set-SCScriptCommand

参考