System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Remove-SCVMHost コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Remove-SCVMHost」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Remove-SCVMHost コマンドレット
名前
Remove-SCVMHost
概要
VMM から仮想マシン ホストを削除します。
構文
| Remove-SCVMHost [-VMHost] <Host> [-Confirm] [-Credential <VMMCredential>] [-JobVariable <String>] [-PROTipID <Guid>] [-RemoveHostWithVMs] [-RunAsynchronously] [-VMMServer <ServerConnection>] [-WhatIf] [<CommonParameters>] Remove-SCVMHost |
説明
Remove-SCVMHost コマンドレットは、Virtual Machine Manager (VMM) から複数の仮想マシン ホストを削除します。Remove-SCVMHost コマンドレット操作は、次のとおり :
- Host Server Only : このコンピューターが Hyper-V ホストでライブラリ サーバーではない場合、ホスト オブジェクトは VMM データベースから削除され、VMM エージェント ソフトウェアは物理ホスト サーバーからアンインストールされます。
ホストが VMware ESX ホスト、もしくは Citrix XenServer ホストの場合、ホスト オブジェクトは VMM データベースから削除されます。VMM は ESX ホスト、もしくは XenServer ホストにエージェントをインストールしません。
- Host And Library Server : このコンピューターが Hyper-V ホストであり、ライブラリ サーバーでもある場合、このコマンドはホスト機能のみを削除しますが、ライブラリ サーバー機能はそのまま残ります。つまり、ホスト オブジェクトは VMM データベースから削除されますが、VMM エージェント ソフトウェアは物理サーバーからアンインストールされません。ライブラリ サーバー オブジェクトはデータベースに残ります。
ホストが ESX ホストの場合、VMM の仮想マシン ホストとしてのみ機能します。ホスト サーバーとライブラリ サーバーの両方になることはできません。
- Credentials : Hyper-V ホストが Active Directory ドメインに参加している場合は、そのホスト コンピューターを VMM から削除するための適切なアクセス許可を持つアカウントの資格情報を提供する必要があります。
VMM から境界ネットワーク ホスト、ESX ホスト、もしくは XenServer ホストを削除するために、Active Directory の資格情報を提供する必要はありません。
- Virtual Machines : ホストを削除すると、そのホストは VMM によって管理されなくなります。ただし、ホスト サーバー上の仮想マシンは、サーバーから削除されたり、関連付け解除されたりしません。実行中の仮想マシンはすべてシャットダウンされません。仮想マシンは VMM によって管理されなくなりましたが、他の方法では影響を受けません。
- Forced Removal : Remove-SCVMHost コマンドレットで Force パラメーターを使用すると、そのホストを管理するための適切な資格情報がない場合、もしくは VMM サーバーがそのホストと通信できなくなった場合に VMM から仮想マシン ホストを削除できます。
Force パラメーターを指定すると、VMM は資格情報を要求、もしくは確認したり、VMM がホストに接続したり、VMM エージェントをアンインストールしたりしません。したがって、VMM データベースから失効したホスト レコードを削除する場合にのみ、Force パラメーターを使用することをお勧めします。
このコマンドレットは、成功すると (MarkedForDeletion を $True に設定して) オブジェクトを返します。失敗するとエラー メッセージを返します。
パラメーター
-Confirm [<SwitchParameter>]
コマンドレットの実行前に確認のプロンプトを表示します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Credential <VMMCredential>
資格情報オブジェクトもしくは一部のコマンドレットで、この操作を実行するアクセス許可を持つアカウントのユーザー名とパスワードを含む Run As アカウント オブジェクトを指定します。もしくは、Restart-SCJob の場合、再起動したタスクを完了するためのアクセス許可が必要となります。
PSCredential オブジェクトに関する詳細な情報は、Get-Help Get-Credential を実行します。
Run As アカウントに関する詳細な情報は、Get-Help New-SCRunAsAccount を実行します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Force [<SwitchParameter>]
ユーザーの確認を求めずにコマンドを強制実行します。
| 必須 | true |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-JobVariable <String>
ジョブの進行状況を追跡し、このパラメーターで指定された変数に格納する場合に指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-PROTipID <Guid>
このアクションにトリガーされるパフォーマンスとリソースの最適化のヒント (PRO ヒント) を指定します。このパラメーターは、PRO ヒントを監査することができます。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-RemoveHostWithVMs [<SwitchParameter>]
PSCredential オブジェクトに関する詳細な情報は、Get-Help Get-Credential を実行します。
Run As アカウントに関する詳細な情報は、Get-Help New-SCRunAsAccount を実行します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-RunAsynchronously [<SwitchParameter>]
ジョブが非同期で実行、制御がすぐにコマンド シェルに戻されるかどうかを指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-VMHost <Host>
仮想マシン ホスト オブジェクトを指定します。VMM は、Hyper-V ホスト、VMware ESX ホスト、および Citrix XenServer ホストをサポートします。
各ホストの種類に関する情報について、Add-SCVMHost コマンドレットを参照してください。
| 必須 | true |
|---|---|
| 位置 | 0 |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-VMMServer <ServerConnection>
VMM サーバー オブジェクトを取得します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-WhatIf [<SwitchParameter>]
コマンドレットを実行する場合の挙動について表示します。コマンドレットは、実際には実行されません。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。
入力
出力
メモ
例
例 1 : VMM からドメイン参加済みホストを削除する
コマンド
$Credential = Get-Credential $VMHost = Get-SCVMHost -ComputerName "VMHost01" Remove-SCVMHost -VMHost $VMHost -Credential $Credential -Confirm
コマンドの説明
最初のコマンドは、Get-Credential コマンドレットを用いてユーザー名とパスワードの入力を求めるプロンプトを表示し、提供された資格情報を $Credential 変数に格納します。この操作に必要な資格情報は、VMM から Active Directory ドメインに参加している Windows ベースのホスト サーバーを削除する管理者権限を持つドメイン アカウントです。
2 番目のコマンドは、ホスト オブジェクト “VMHost01” を取得し、そのオブジェクトを $VMHost 変数に格納します。
3 番目のコマンドは、$VMHost に格納されているホスト オブジェクトを削除します。このコマンドが処理されると、$Credential は Remove-VMHost に資格情報を提供し、Confirm パラメーターは、このホストを VMM から削除するかどうかを確認するメッセージを表示します。
例 2 : VMM からホスト クラスター内のノードではないすべてのホストを削除する
コマンド
Get-SCVMHost | where {$_.HostCluster -eq $NULL} | where {$_.VirtualizationPlatform -eq "VMwareESX" -or $_.PerimeterNetworkHost -eq 1 -or $_.NonTrustedDomainHost -eq 1} | Remove-SCVMHost -Confirm
$Credential = Get-Credential
Get-VMHost | where {$_.HostCluster -eq $NULL -and $_.VirtualizationPlatform -ne "VMwareESX" -and $_.PerimeterNetworkHost -eq 0 -and $_.NonTrustedDomainHost -eq 0} | Remove-VMHost -Credential $Credential -Confirm
コマンドの説明
最初のコマンドは、すべてのホストオブジェクトを取得し、ホスト クラスター内のノードであるホストは除外し、VMware ESX ホスト、境界ネットワーク ホスト、もしくは信頼されていないドメイン ホストを表すオブジェクトのみを選択してから、VMM からそれらのオブジェクトを削除します。これらのホストを削除するために資格情報は必要ありません。
2 番目のコマンドは、ドメイン参加済み Windows ホストを VMM から削除する権限を持つアカウントのユーザー名とパスワードを入力するように求め、その資格情報を $Credential に格納します。
最後のコマンドは、ホスト クラスターの一部ではないドメインに参加したすべての Windows ベースのホスト オブジェクトを取得し、そのオブジェクトを Remove-VMHost コマンドレットに渡します。このコマンドが処理されると、$Credential は自分の資格情報を Remove-VMHost に提供し、Confirm パラメーターはこれらのホストを VMM から削除するかどうかを確認するメッセージを表示します。
例 3 : VMM からアクセス不能な特定のホストを削除する
コマンド
$VMHost = Get-SCVMHost -ComputerName "VMHost03" Remove-SCVMHost -VMHost $VMHost -Force -Confirm
コマンドの説明
最初のコマンドは、ホスト オブジェクト “VMHost03” を取得し、そのオブジェクトを $VMHost 変数に格納します。
2 番目のコマンドは、Force パラメーターをオンにして、VMHost03 が VMM データベースから確実に削除されるようにします。この操作には資格情報は必要ありません。Confirm パラメーターは、このホストを削除するかどうかを確認するメッセージを表示します。
注 : そのホストの資格情報を持たない場合、もしくは VMM サーバーがそのホストと通信できなくなった場合に、Force パラメーターを使用して VMM からホストを削除できます。
関連するリンク
- Add-SCVMHost
- Disable-SCVMHost
- Enable-SCVMHost
- Get-SCVMHost
- Move-SCVMHost
- New-SCVMHost
- Read-SCVMHost
- Register-SCVMHost
- Repair-SCVMHost
- Restart-SCVMHost
- Set-SCVMHost
- Start-SCVMHost
- Stop-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 - Remove-SCVMHost (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/remove-scvmhost?view=systemcenter-ps-2016
