System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Stop-SCVMHost コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Stop-SCVMHost」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Stop-SCVMHost コマンドレット
名前
Stop-SCVMHost
概要
VMM によって管理されているホストを停止します。
構文
| Stop-SCVMHost [-VMHost] <Host> [-Confirm] [-JobVariable <String>] [-PROTipID <Guid>] [-RunAsynchronously] [-UseOutOfBandChannel] [-WhatIf] [<CommonParameters>] |
説明
Stop-SCVMHost コマンドレットは、Power Off コマンドを発行して Virtual Machine Manager (VMM) によって管理されているホストを停止します。
ホストを停止するには、帯域内と帯域外 (OOB) の 2 つの方法があります。既定のパラメーター セットでは、帯域内方式を使用してホストをシャットダウンします。OOB 方式を使用するには、ホストを OOB 管理用に設定する必要があります。ホストのベースボード管理コントローラー (BMC) 設定を構成する方法については、Get-Help Set-SCVMHost -Detailed を実行してください。
パラメーター
-Confirm [<SwitchParameter>]
コマンドレットの実行前に確認のプロンプトを表示します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-JobVariable <String>
ジョブの進行状況を追跡し、このパラメーターで指定された変数に格納する場合に指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-PROTipID <Guid>
このアクションにトリガーされるパフォーマンスとリソースの最適化のヒント (PRO ヒント) を指定します。このパラメーターは、PRO ヒントを監査することができます。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-RunAsynchronously [<SwitchParameter>]
ジョブが非同期で実行、制御がすぐにコマンド シェルに戻されるかどうかを指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-UseOutOfBandChannel [<SwitchParameter>]
帯域外の管理チャネルを用いて操作を実行する必要がある場合に指定します。このパラメーターは、コンピューターが応答しない場合にのみ使用してください。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-VMHost <Host>
仮想マシン ホスト オブジェクトを指定します。VMM は、Hyper-V ホスト、VMware ESX ホスト、および Citrix XenServer ホストをサポートします。
各ホストの種類に関する情報について、Add-SCVMHost コマンドレットを参照してください。
| 必須 | true |
|---|---|
| 位置 | 0 |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-WhatIf [<SwitchParameter>]
コマンドレットを実行する場合の挙動について表示します。コマンドレットは、実際には実行されません。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。
入力
出力
- Host
- このコマンドレットは、Host オブジェクトを返します。
メモ
例
例 1 : 帯域内管理を用いて指定したホストの電源を切る
コマンド
Get-SCVMHost -ComputerName "NewHost01" | Stop-SCVMHost -Confirm
コマンドの説明
このコマンドは、ホスト オブジェクト “NewHost01” を取得し、ホストの電源を切断します。処理を続行する前に、アクションの確認を求めるプロンプトが表示されます。
例 2 : 帯域外管理を用いて指定したホストの電源を切る
コマンド
Get-SCVMHost -ComputerName "NewHost01" | Stop-SCVMHost -UseOutOfBandChannel -Confirm
コマンドの説明
このコマンドは、ホスト オブジェクト “NewHost01” を取得し、OOB 管理を用いてホストの電源を切断します。続行する前に、確認を求めるプロンプトが表示されます。
関連するリンク
- Add-SCVMHost
- Disable-SCVMHost
- Enable-SCVMHost
- Get-SCCertificate
- Get-SCVMHost
- Move-SCVMHost
- Read-SCVMHost
- Register-SCVMHost
- Remove-SCVMHost
- Restart-SCVMHost
- Set-SCVMHost
参考
- 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-SCVMHost (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/stop-scvmhost?view=systemcenter-ps-2016
