System Center 2016 – Virtual Machine Manager (SCVMM 2016) に触れる機会が多くなり、Virtual Machine Manager Command Shell を使った設定や、情報取得、および管理することが増えてきたので、備忘録として各コマンドレットの概要を日本語化 (意訳) しました。
ここでは Remove-SCPXEServer コマンドレットのヘルプ情報について、SCVMM2016 UR5 の Virtual Machine Manager Command Shell 上で「Remove-SCPXEServer」コマンドレットの -Full オプションを用いて実行した結果を元に記載しています。
※SCVMM 2016 UR5 で利用可能なコマンドレット一覧については、「System Center 2016 – Virtual Machine Manager で利用できるコマンドレットについて」を参照。
Remove-SCPXEServer コマンドレット
名前
Remove-SCPXEServer
概要
VMM データベースから PXEServer オブジェクトを削除します。
構文
| Remove-SCPXEServer [-PXEServer] <PxeServer> [-Confirm] -Credential <VMMCredential> [-Force] [-JobVariable <String>] [-PROTipID <Guid>] [-RunAsynchronously] [-VMMServer <ServerConnection>] [-WhatIf] [<CommonParameters>] |
説明
Remove-SCPXEServer コマンドレットは、Virtual Machine Manager (VMM) データベースから PXEServer オブジェクトを削除し、Windows 展開サービス コンピューターから VMM エージェントをアンインストールします。このコマンドレットは、Windows 展開サービスの役割をコンピューターから削除しません。
パラメーター
-Confirm [<SwitchParameter>]
コマンドレットの実行前に確認のプロンプトを表示します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | false |
-Credential <VMMCredential>
資格情報オブジェクトもしくは一部のコマンドレットで、この操作を実行するアクセス許可を持つアカウントのユーザー名とパスワードを含む Run As アカウント オブジェクトを指定します。もしくは、Restart-SCJob の場合、再起動したタスクを完了するためのアクセス許可が必要となります。
PSCredential オブジェクトに関する詳細な情報は、Get-Help Get-Credential を実行します。
Run As アカウントに関する詳細な情報は、Get-Help New-SCRunAsAccount を実行します。
| 必須 | true |
|---|---|
| 位置 | 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 |
-PXEServer <PxeServer>
PXE サーバー オブジェクトを指定します。
| 必須 | true |
|---|---|
| 位置 | 0 |
| 既定値 | None |
| パイプライン入力を許可する | True (ByValue) |
| ワイルドカード文字を許可する | false |
-RunAsynchronously [<SwitchParameter>]
ジョブが非同期で実行、制御がすぐにコマンド シェルに戻されるかどうかを指定します。
| 必須 | false |
|---|---|
| 位置 | named |
| 既定値 | False |
| パイプライン入力を許可する | False |
| ワイルドカード文字を許可する | 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 PXE サーバーを削除する
コマンド
$Credential = Get-SCRunAsAccount "RunAsAcct01" $PXEServer = Get-SCPXEServer -ComputerName "WDSServer01.Contoso.com" Remove-SCPXEServer -PXEServer $PXEServer -Credential $Credential -Confirm
コマンドの説明
最初のコマンドは、Get-Credential コマンドレットを用いてユーザー名とパスワードの入力を求めるプロンプトを表示、提供された資格情報を $Credential 変数に格納します。アカウントには、PXE サーバーに対するローカル管理者権限が必要となります。
2 番目のコマンドは、PXE サーバー オブジェクト “WDSServer01.Contoso.com” を取得し、そのオブジェクトを $PXEServer 変数に格納します。
3 番目のコマンドは、$PXEServer に格納されている PXE サーバー オブジェクトを削除します。このコマンドが処理されると、$Credential は Remove-SCPXEServer に資格情報を提供し、Confirm パラメーターは、この PXE サーバーを VMM から削除することを確認するように求めます。
関連するリンク
- Add-SCPXEServer
- Get-SCPXEServer
- Get-SCRunAsAccount
参考
- 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-SCPXEServer (VirtualMachineManager) | Microsoft Docs
https://docs.microsoft.com/en-us/powershell/module/virtualmachinemanager/remove-scpxeserver?view=systemcenter-ps-2016