System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Stop-SCJob コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Stop-SCJob」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Stop-SCJob コマンドレット
名前
Stop-SCJob
概要
実行中の VMM ジョブを停止します。
構文
| Stop-SCJob [-Job] <Task> [-OnBehalfOfUser <String>] [-OnBehalfOfUserRole <UserRole>] [<CommonParameters>] |
説明
Stop-SCJob コマンドレットは、実行中の複数の Virtual Machine Manager (VMM) ジョブを停止し、各ジョブのオブジェクトを停止状態で返します。VMM ジョブが現在実行されていない場合、このコマンドレットは無効です。
パラメーター
-Job <Task>
VMM ジョブ オブジェクトを指定します。
| 必須 | true |
|---|---|
| 位置 | 0 |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-OnBehalfOfUser <String>
ユーザー名を指定します。このコマンドレットは、このパラメーターが指定するユーザーの代わりに操作します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-OnBehalfOfUserRole <UserRole>
ユーザー ロールを指定します。ユーザー ロールを取得するには、Get-SCUserRole コマンドレットを用います。このコマンドレットは、このパラメーターで指定するユーザー ロールの代わりに操作します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。
入力
出力
- Task
- このコマンドレットは、Task オブジェクトを返します。
メモ
このコマンドレットには、Get-SCJob コマンドレットを用いて取得可能な VMM ジョブ オブジェクトが必要となります。
例
例 1 : 現在実行中のすべてのジョブを停止する
コマンド
$Job = Get-SCJob | where { $_.Status -eq "Running" }
$Job | Stop-SCJob
コマンドの説明
最初のコマンドは、すべての VMM ジョブ オブジェクトを取得し、各ジョブ オブジェクトを “where” フィルタに渡して、現在実行中 (“Running”) のジョブのみを選択し、オブジェクトを $Job オブジェクト配列に格納します。
2 番目のコマンドは、$Job 内の各オブジェクトを Stop-SCJob コマンドレットに渡します。このコマンドレットは実行中の各ジョブを停止します。
例 2 : 実行中の特定のジョブを非同期に停止する
コマンド
$Job = Get-SCJob | where { $_.ResultName -eq "VM01" -and $_.ID -eq "cb3a0f0a-9fbc-4bd0-a999-3fae8cd77177" }
Stop-SCJob -Job $Job
コマンドの説明
最初のコマンドはすべての VMM ジョブ オブジェクトを取得し、ジョブID “cb3a0f0a-9fbc-4bd0-a999-3fae8cd77177” で識別される VM01 のジョブのみを選択、$Job 変数に格納します。
2 番目のコマンドはジョブを停止し、停止したジョブ オブジェクトを返します。
関連するリンク
- Find-SCJob
- Get-SCJob
- Restart-SCJob
参考
- System Center 2016 – データセンターの管理 | Microsoft
https://www.microsoft.com/ja-jp/cloud-platform/system-center - VirtualMachineManager | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/?view=systemcenter-ps-2016 - Stop-SCJob (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/stop-scjob?view=systemcenter-ps-2016