System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Remove-SCGuestOSProfile コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Remove-SCGuestOSProfile」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Remove-SCGuestOSProfile コマンドレット
名前
Remove-SCGuestOSProfile
概要
VMM からゲスト OS プロファイル オブジェクトを削除します。
構文
| Remove-SCGuestOSProfile [-GuestOSProfile] <GuestOSProfile> [-Confirm] [-Force] [-JobVariable <String>] [-PROTipID <Guid>] [-RunAsynchronously] [-WhatIf] [<CommonParameters>] |
説明
Remove-SCGuestOSProfile コマンドレットは、VMM から複数のゲスト OS プロファイル オブジェクトを削除します。
このコマンドレットは、成功すると (MarkedForDeletion プロパティが True に設定された) オブジェクトを返します。失敗するとエラー メッセージを返します。
パラメーター
-Confirm [<SwitchParameter>]
コマンドレットの実行前に確認のプロンプトを表示します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Force [<SwitchParameter>]
ユーザーの確認を求めずにコマンドを強制実行します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-GuestOSProfile <GuestOSProfile>
ゲスト OS プロファイル オブジェクトを指定します。
| 必須 | 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-SCGuestOSProfile コマンドレットを用いて取得可能な VMM ゲスト OS プロファイル オブジェクトが必要となります。
例
例 1 : ライブラリから特定のゲスト OS プロファイルを削除する
コマンド
$OSProfile = Get-SCGuestOSProfile -Name "NewOSProfile01" Remove-SCGuestOSProfile -GuestOSProfile $OSProfile -Confirm
コマンドの説明
最初のコマンドは、ゲスト OS プロファイル オブジェクト “NewOSProfile01” を取得し、そのオブジェクトは $OSProfile 変数を指定します。
2 番目のコマンドは、$OSProfile に格納されているゲスト OS プロファイルを削除し、操作を完了する前に確認を求めます。
例 2 : それぞれの削除の確認を求めるプロンプトを表示せずにすべての OS プロファイルを削除する
コマンド
$OSProfiles = Get-SCGuestOSProfile -VMMServer "VMMServer01.Contoso.com" $OSProfiles | Remove-SCGuestOSProfile
コマンドの説明
最初のコマンドは、”VMMServer01.Contoso.com” からすべての OS プロファイル オブジェクトを取得し、そのオブジェクトを $OSProfiles オブジェクト配列に格納します。
2 番目のコマンドは、$OSProfiles の各オブジェクトを Remove-OSProfile コマンドレットに渡します。このコマンドレットは VMM ライブラリから各 OS プロファイル オブジェクトを削除します。
関連するリンク
- Get-SCGuestOSProfile
- New-SCGuestOSProfile
- Set-SCGuestOSProfile
参考
- 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-SCGuestOSProfile (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/remove-scguestosprofile?view=systemcenter-ps-2016