Add-SCPXEServer

Adds an existing Windows Deployment Services computer to VMM.

Description

The Add-SCPXEServer cmdlet installs a System Center Virtual Machine Manager (VMM) agent on an existing Windows Deployment Services computer and creates a PXEServer object for that computer in the VMM database.

For more information about Add-SCPXEServer, type: "Get-Help Add-SCPXEServer -online".

Parameters

ComputerName

Required? true
Accept Pipeline Input? true (ByValue)
Position? 0
Specifies the name of a computer that VMM can uniquely identify on your network. Valid formats are: FQDN, IPv4 or IPv6 address, or NetBIOS name.

NOTE: See the examples for a specific cmdlet to determine how that cmdlet specifies the computer name.

Credential

Required? true
Accept Pipeline Input? false
Position? named
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".

JobVariable

Required? false
Accept Pipeline Input? false
Position? named
Specifies that job progress is tracked and stored in the variable named by this parameter. 

PROTipID

Required? false
Accept Pipeline Input? false
Position? named
Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

RunAsynchronously

Required? false
Accept Pipeline Input? false
Position? named
Indicates that the job runs asynchronously so that control returns to the command shell immediately. 

VMMServer

Required? false
Accept Pipeline Input? true (ByValue)
Position? named
Specifies a VMM server object.

Examples

1: Add a PXE server to VMM.
PS C:\> $Credential = Get-SCRunAsAccount -Name "RunAsAcct01"
PS C:\> Add-SCPXEServer -ComputerName “WDSServer01.Contoso.com” -Credential $Credential
The first command gets the Run As account object named RunAsAccount01 and stores the object in the $Credential variable. The account must have local Administrator permissions on the PXE server.

The second command adds the PXE server named WDSServer01 using the Run As account stored in $Credential.

See Also