Remove-SCPXEServer

[アーティクル]
11/16/2015

Remove-SCPXEServer

Removes a PXEServer object from the VMM database.

構文

Parameter Set: Default
Remove-SCPXEServer [-PXEServer] <PxeServer> -Credential <VMMCredential> [-Force] [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Remove-SCPXEServer cmdlet removes a Pre-Boot EXecution Environment (PXE) PXEServer object from the Virtual Machine Manager (VMM) database, and uninstalls the VMM agent from the Windows Deployment Services computer. This cmdlet does not remove the Windows Deployment Services role from the computer.

パラメーター

-Credential<VMMCredential>

Specifies a credential object or, for some cmdlets, a Run As account object that contains the user name and password of an account that has permission to perform this action. Or, in the case of Restart-SCJob, has permission to complete a restarted task.

For more information about the PSCredential object, type Get-Help Get-Credential. For more information about Run As accounts, type Get-Help New-SCRunAsAccount.

エイリアス	none
必須?	true
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Force

Forces the operation to complete.

For example:

- Remove-SCSCVMHost -Force

Forces the removal of a host object from the VMM database.

- Stop-SCVirtualMachine -Force

Stops a virtual machine.

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-PROTipID<Guid]>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-PXEServer<PxeServer>

Specifies a PXE server object.

エイリアス	none
必須?	true
位置は?	1
既定値	none
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-VMMServer<ServerConnection>

Specifies a VMM server object.

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-Confirm

コマンドレットを実行する前に、ユーザーに確認を求めます。

必須?	false
位置は?	named
既定値	false
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-WhatIf

コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。

必須?	false
位置は?	named
既定値	false
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

例

Example 1: Remove a VMM PXE server

The first command uses the Get-SCRunAsAccount cmdlet to prompt you to supply a user name and password, and then stores the provided credentials in the $Credential variable. The account must have local Administrator permissions on the PXE server.

The second command gets the PXE server object named WDSServer01, and then stores the object in the $PXEServer variable.

The third command removes the PXE server object stored in $PXEServer. As this command is processed, $Credential provides credentials to Remove-SCPXEServer. The command prompts you to confirm that you do want to remove this PXE server from VMM.

PS C:\> $Credential = Get-SCRunAsAccount "RunAsAcct01"
PS C:\> $PXEServer = Get-SCPXEServer -ComputerName "WDSServer01.Contoso.com"
PS C:\> Remove-SCPXEServer -PXEServer $PXEServer -Credential $Credential -Confirm

Remove-SCPXEServer