System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Remove-SCHardwareProfile コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Remove-SCHardwareProfile」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Remove-SCHardwareProfile コマンドレット
名前
Remove-SCHardwareProfile
概要
VMM ライブラリからハードウェア プロファイル オブジェクトを削除します。
構文
| Remove-SCHardwareProfile [-HardwareProfile] <HardwareProfile> [-Confirm] [-JobVariable <String>] [-PROTipID <Guid>] [-RunAsynchronously] [-WhatIf] [<CommonParameters>] |
説明
Remove-SCHardwareProfile コマンドレットは、Virtual Machine Manager (VMM) ライブラリから複数のハードウェア プロファイル オブジェクトを削除します。
このコマンドレットは、成功したときに MarkedForDeletion プロパティを $True に設定してオブジェクトを返します。失敗するとエラー メッセージを返します。
パラメーター
-Confirm [<SwitchParameter>]
コマンドレットの実行前に確認のプロンプトを表示します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-HardwareProfile <HardwareProfile>
ハードウェア プロファイル オブジェクトを指定します。
| 必須 | true |
|---|---|
| 位置 | 0 |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-JobVariable <String>
ジョブの進行状況を追跡し、このパラメーターで指定された変数に格納する場合に指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-PROTipID <Guid>
このアクションにトリガーされるパフォーマンスとリソースの最適化のヒント (PRO ヒント) を指定します。このパラメーターは、PRO ヒントを監査することができます。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | None |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-RunAsynchronously [<SwitchParameter>]
ジョブが非同期で実行、制御がすぐにコマンド シェルに戻されるかどうかを指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-WhatIf [<SwitchParameter>]
コマンドレットを実行する場合の挙動について表示します。コマンドレットは、実際には実行されません。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer, PipelineVariable、および OutVariable。詳細については、about_CommonParameters を参照してください。
入力
出力
メモ
Get-SCHardwareProfile コマンドレットを用いて取得可能な VMM ハードウェア プロファイル オブジェクトが必要となります。
例
例 1 : ライブラリから特定のハードウェア プロファイルを削除する
コマンド
$HWProfile = Get-SCHardwareProfile | where { $_.Name -eq "NewHWProfile01"}
Remove-SCHardwareProfile -HardwareProfile $HWProfile -Confirm
コマンドの説明
最初のコマンドは、VMM ライブラリからハードウェア プロファイル オブジェクト “NewHWProfile01” を取得し、そのオブジェクトを $HWProfile 変数に格納します。
2 番目のコマンドは、ライブラリから NewHWProfle01 を削除し、操作を完了する前に確認を促します。
例 2 : それぞれの削除を確認するプロンプトが表示せずにすべてのハードウェア プロファイルを削除する
コマンド
Get-SCHardwareProfile | Remove-SCHardwareProfile
コマンドの説明
このコマンドは、ライブラリ内のすべてのハードウェア プロファイル オブジェクトを取得し、各プロファイル オブジェクトを Remove-SCHardwareProfile コマンドレットに渡します。このコマンドレットは、各ハードウェア プロファイルを削除します。Confirm パラメーターを使用しない場合、これらのハードウェア プロファイル オブジェクトを削除するかどうかを確認するプロンプトは表示されません。
関連するリンク
- Get-SCHardwareProfile
- New-SCHardwareProfile
- Set-SCHardwareProfile
参考
- 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-SCHardwareProfile (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/remove-schardwareprofile?view=systemcenter-ps-2016