System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Suspend-SCVirtualMachine コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Suspend-SCVirtualMachine」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Suspend-SCVirtualMachine コマンドレット
名前
Suspend-SCVirtualMachine
概要
VMM によって管理されている仮想マシンを一時停止します。
構文
| Suspend-SCVirtualMachine [-VM] <VM> [-JobVariable <String>] [-OnBehalfOfUser <String>] [-OnBehalfOfUserRole <UserRole>] [-PROTipID <Guid>] [-RunAsynchronously] [<CommonParameters>] |
説明
Suspend-SCVirtualMachine コマンドレットは、Virtual Machine Manager (VMM) によって管理されている複数の仮想マシンを一時停止します。このコマンドレットは、仮想マシン上のアクティビティを一時停止し、その仮想マシンを一時停止状態を表すオブジェクトを返します。
一時停止した仮想マシンの実行を再開するには、Resume-SCVirtualMachine を用います。
パラメーター
-JobVariable <String>
ジョブ進行状況を追跡、格納する変数を指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-OnBehalfOfUser <String>
ユーザー名を指定します。このコマンドレットは、このパラメーターが指定するユーザーの代わりに操作します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-OnBehalfOfUserRole <UserRole>
ユーザー ロールを指定します。ユーザー ロールを取得するには、Get-SCUserRole コマンドレットを用います。このコマンドレットは、このパラメーターで指定するユーザー ロールの代わりに操作します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-PROTipID <Guid>
このアクションにトリガーされるパフォーマンスとリソースの最適化のヒント (PRO ヒント) を指定します。このパラメーターは、PRO ヒントを監査することができます。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-RunAsynchronously [<SwitchParameter>]
ジョブが非同期で実行、制御がすぐにコマンド シェルに戻されるかどうかを指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-VM <VM>
仮想マシン オブジェクトを指定します。
| 必須 | true |
|---|---|
| 位置 | 0 |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。
入力
出力
- VirtualMachine
メモ
このコマンドレットには、Get-SCVirtualMachine コマンドレットを用いて取得可能な仮想マシン オブジェクトが必要となります。
例
例 1 : 指定した仮想マシンを一時停止する
コマンド
$VM = Get-SCVirtualMachine -Name "VM01" Suspend-SCVirtualMachine -VM $VM
コマンドの説明
最初のコマンドは、仮想マシン オブジェクト VM01 を取得し、そのオブジェクトを $VM 変数に格納します。
2 番目のコマンドは、$VM に格納された仮想マシンを一時停止し、一時停止したオブジェクトに関する情報を表示します。
関連するリンク
- Get-SCUserRole
- Get-SCVirtualMachine
- Move-SCVirtualMachine
- New-SCVirtualMachine
- Read-SCVirtualMachine
- Register-SCVirtualMachine
- Remove-SCVirtualMachine
- Repair-SCVirtualMachine
- Reset-SCVirtualMachine
- Resume-SCVirtualMachine
- Set-SCVirtualMachine
- Start-SCVirtualMachine
- Stop-SCVirtualMachine
参考
- 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 - Suspend-SCVirtualMachine (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/suspend-scvirtualmachine?view=systemcenter-ps-2016
