System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Restart-SCJob コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Restart-SCJob」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Restart-SCJob コマンドレット
名前
Restart-SCJob
概要
失敗、キャンセルした VMM ジョブを再開します。
構文
| Restart-SCJob [-Job] <Task> [-Credential <VMMCredential>] [-OnBehalfOfUser <String>] [-OnBehalfOfUserRole <UserRole>] [-SkipLastFailedStep] [<CommonParameters>] |
説明
Restart-SCJob コマンドレットは、失敗したか、ユーザーによってキャンセルされた複数の Virtual Machine Manager (VMM) ジョブを再開します。現在実行中のジョブは、再開する前にキャンセルする必要があります。すべての再開されたジョブは、障害または取り消し前に最後の正常なチェックポイントから開始します (一部のジョブではチェックポイントが1つしかありません)。
ジョブを再起動すると、ジョブのオブジェクト プロパティが表示され、Status プロパティが Running として表示されます。
パラメーター
-Credential <VMMCredential>
資格情報オブジェクトもしくは一部のコマンドレットで、この操作を実行するアクセス許可を持つアカウントのユーザー名とパスワードを含む Run As アカウント オブジェクトを指定します。もしくは、Restart-SCJob の場合、再起動したタスクを完了するためのアクセス許可が必要となります。
PSCredential オブジェクトに関する詳細な情報は、Get-Help Get-Credential を実行します。
Run As アカウントに関する詳細な情報は、Get-Help New-SCRunAsAccount を実行します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-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 |
-SkipLastFailedStep [<SwitchParameter>]
ジョブが再開されたときに、失敗した最後のステップを再実行しない場合に指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。
入力
出力
- Job
- このコマンドレットは、Job オブジェクトを返します。
メモ
このコマンドレットには、Get-SCJob コマンドレットを用いて取得可能な VMM ジョブ オブジェクトが必要となります。
例
例 1 : 特定の仮想マシンでキャンセルされたすべてのジョブを再起動する
コマンド
$Creds = Get-SCRunAsAccount -Name "RunAsAccount01"
Get-SCJob | where { $_.ResultName -eq "VM01" -and $_.Status -eq "Canceled" } | Restart-SCJob -Credential $Creds
コマンドの説明
最初のコマンドは Run As アカウント オブジェクト “RunAsAccount01” を取得し、そのオブジェクトを $Creds 変数に格納します。
2 番目のコマンドは、VMM データベースからすべての VMM ジョブを取得し、取り消された仮想マシン “VM01” のジョブのみを選択し、各オブジェクトを Restart-SCJob コマンドレットに渡します。このコマンドレットは、$Creds で指定された Run As アカウントを使用してジョブを再開します。
例 2 : 特定のジョブを再起動する
コマンド
$Creds = Get-SCRunAsAccount -Name "RunAsAccount01" Get-SCJob -ID "cb3a0f0a-9fbc-4bd0-a999-3fae8cd77177" | Restart-SCJob -Credential $Creds
コマンドの説明
最初のコマンドは Run As アカウント オブジェクト “RunAsAccount01” を取得し、そのオブジェクトを $Creds 変数に格納します。
2 番目のコマンドは ID が “cb3a0f0a-9fbc-4bd0-a999-3fae8cd77177” の VMM ジョブ オブジェクトを取得し、$Creds で指定された Run As アカウントを使用してそのジョブを再開します。
関連するリンク
- Find-SCJob
- Get-SCJob
- Stop-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 - Restart-SCJob (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/restart-scjob?view=systemcenter-ps-2016
