System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Remove-SCVMHostCluster コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Remove-SCVMHostCluster」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Remove-SCVMHostCluster コマンドレット
名前
Remove-SCVMHostCluster
概要
VMM からホスト クラスター オブジェクトを削除します。
構文
| Remove-SCVMHostCluster [-VMHostCluster] <HostCluster> [-Confirm] [-Credential <VMMCredential>] [-JobVariable <String>] [-PROTipID <Guid>] [-RunAsynchronously] [-WhatIf] [<CommonParameters>] Remove-SCVMHostCluster |
説明
Remove-SCVMHostCluster コマンドレットは、Virtual Machine Manager (VMM) から複数のホスト クラスター オブジェクトを削除します。Remove-SCVMHostCluster はクラスターを破壊しません。VMM を用いてホスト クラスターのクラスターを解除するには、Uninstall-SCVMHostCluster コマンドレットを使用します。
パラメーター
-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>]
ユーザーの確認を求めずにコマンドを強制実行します。
| 必須 | 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 |
-VMHostCluster <HostCluster>
VMM ホスト クラスター オブジェクトを指定します。
| 必須 | 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 を参照してください。
入力
出力
メモ
例
例 1 : VMM から特定のホスト クラスターを削除する
コマンド
$Credential = Get-SCRunAsAccount -Name "RunAsAccount01" $Cluster = Get-SCVMHostCluster -Name "VMHostCluster01.Contoso.com" Remove-SCVMHostCluster -VMHostCluster $Cluster -Credential $Credential -Confirm
コマンドの説明
最初のコマンドは、Run As アカウント オブジェクト RunAsAccount01″ を取得し、そのオブジェクトを $Credential 変数に格納します。この操作に使用される Run As アカウントは、削除するフェールオーバー クラスターのすべてのノードに対して管理者アクセス権を持つドメイン アカウントである必要があります。
2 番目のコマンドは、フェールオーバー クラスター オブジェクト “VMHostCluster01.Contoso.com” を取得し、そのオブジェクトを $VMHostCluster 変数に格納します。
最後のコマンドは、VMHostCluster01 クラスター オブジェクトを VMM データベースから削除し、ユーザーに確認を求めた後、そのホスト クラスターの管理を停止します。ホスト クラスター設定、もしくは既存の仮想マシンは変更されません。このコマンドが処理されると、$Credential は保存された Run As アカウントを Remove-SCVMHostCluster に提供します。
例 2 : VMM からすべてのホスト クラスターを削除する
コマンド
$Credential = Get-SCRunAsAccount -Name "RunAsAccount01" Get-SCVMHostCluster | Remove-SCVMHostCluster -Credential $Credential -Confirm
コマンドの説明
最初のコマンドは、Run As アカウント オブジェクト RunAsAccount01″ を取得し、そのオブジェクトを $Credential 変数に格納します。この操作に使用される Run As アカウントは、削除するフェールオーバー クラスターのすべてのノードに対して管理者アクセス権を持つドメイン アカウントである必要があります。
2 番目のコマンドは、すべてのホスト クラスタ－ オブジェクトを取得し、そのオブジェクトを Remove-SCVMHostCluster コマンドレットに渡します。このコマンドレットは、VMM から各ホスト クラスター オブジェクトを削除し、ユーザーに確認を求めた後、対応するホスト クラスターの管理を停止します。コマンドは、ホスト クラスター設定、もしくは既存の仮想マシンを変更しません。このコマンドが処理されると、$Credential は、保存された Run As アカウントを Remove-SCVMHostCluster に提供します。
関連するリンク
- Add-SCVMHostCluster
- Get-SCVMHostCluster
- Install-SCVMHostCluster
- Move-SCVMHostCluster
- Read-SCVMHostCluster
- Set-SCVMHostCluster
- Test-SCVMHostCluster
- Uninstall-SCVMHostCluster
参考
- 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-SCVMHostCluster (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/remove-scvmhostcluster?view=systemcenter-ps-2016