System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Get-SCJob コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Get-SCJob」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Get-SCJob コマンドレット
名前
Get-SCJob
概要
VMM ジョブ オブジェクトを取得します。
構文
| Get-SCJob [[-Name] <String>] -All [-Full] [-ID <Guid>] [-Job <Task>] [-OnBehalfOfUser <String>] [-OnBehalfOfUserRole <UserRole>] [-VMMServer <ServerConnection>] [<CommonParameters>] Get-SCJob Get-SCJob |
説明
Get-SCJob コマンドレットは、VMM サーバー上に存在する Virtual Machine Manager (VMM) ジョブ オブジェクト情報を取得します。ジョブは、VMM 環境でアクションを完了するために順番に実行される一連のステップです。 指定した条件に基づいてジョブ オブジェクトを取得することができます。
VMM では、一連のジョブをグループ化し、それらを 1 つのセットとして一緒に実行することが可能です。例として、VMM の複雑なアクション (テンプレートの作成など) には、ジョブ グループと呼ばれる一連のジョブが組み込まれている場合があります。ジョブ グループの使用方法に関する例については、次のコマンドレットを参照してください : New-SCVMTemplate、New-SCHardwareProfile、New-SCVirtualDiskDrive、New-SCVirtualDVDDrive、New-SCVirtualMachine、および Set-SCVirtualCOMPort。
パラメーター
-All [<SwitchParameter>]
このコマンドレットが親オブジェクトから独立したすべての従属オブジェクトを取得する場合に指定します。例えば、コマンド Get-SCVirtualDiskDrive -All は、各仮想ディスク ドライブ オブジェクトが関連付けられている仮想マシン オブジェクト、もしくはテンプレート オブジェクトに関係なく、すべての仮想ディスク ドライブ オブジェクトを取得します。
| 必須 | true |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Full [<SwitchParameter>]
コマンドレットが監査レコードを持つジョブ 王ジェクトを返す場合に指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-ID <Guid>
特定のオブジェクトに対するグローバル一意識別子、もしくは GUID として数値 ID を指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Job <Task>
VMM ジョブ オブジェクトを指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Name <String>
VMM オブジェクト名を指定します。
| 必須 | false |
|---|---|
| 位置 | 0 |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Newest <Int32>
最後に指定した時間内に作成されたすべてのジョブを返す、もしくは指定した数の最新のソフトウェア更新を返します。
- 最後の 48 時間に作成されたすべてのジョブを返すフォーマット例 : Get-SCJob -Newest 48
- 最新 10 個の更新を返すフォーマットフォーマット例 : Get-SCUpdate -Newest 10
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-OnBehalfOfUser <String>
ユーザー名を指定します。このコマンドレットは、このパラメーターが指定するユーザーの代わりに操作します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-OnBehalfOfUserRole <UserRole>
ユーザー ロールを指定します。ユーザー ロールを取得するには、Get-SCUserRole コマンドレットを用います。このコマンドレットは、このパラメーターで指定するユーザー ロールの代わりに操作します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Running [<SwitchParameter>]
すべての実行中のジョブを返すかどうかを指定します。
| 必須 | true |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-VMMServer <ServerConnection>
VMM サーバー オブジェクトを取得します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。
入力
出力
- Job
- このコマンドレットは、Job オブジェクトを返します。
メモ
例
例 1 : すべての実行中のジョブ情報を取得する
コマンド
Get-Job -Running
コマンドの説明
このコマンドは、すべての実行中のジョブ情報を取得します。
例 2 : すべての失敗したジョブ情報を取得する
コマンド
$VMMJobs = Get-SCJob | where { $_.Status -eq "Failed" } | Format-List -Property Name, ID, Status
$VMMJobs
コマンドの説明
最初のコマンドは、”Failed” 状態のすべてのジョブ オブジェクトを取得し、パイプライン演算子を使用して各オブジェクトを Format-List コマンドレットに渡します。このコマンドレットは、$VMMJobs 変数に名前、ID、および Status を格納します。
2 番目のコマンドは、$VMMJobs に格納された情報 (このケースでは、各実行中のジョブの名前、ID、および Status です) を表示します。
例 3 : VMM ジョブ オブジェクトの .NET の種類、方式、およびプロパティに関する情報を取得する
コマンド
Get-SCJob | Get-Member
コマンドの説明
このコマンドは、Get-SCJob に対する.Net の種類、プロパティ、方式、およびイベントを表示するために、Get-Member コマンドレットを使用します。
関連するリンク
- Find-SCJob
- Restart-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 - Get-SCJob (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/Get-SCJob?view=systemcenter-ps-2016
