Add-SCPXEServer

Adds an existing Windows Deployment Services computer to VMM.

Syntax

Add-SCPXEServer [-ComputerName] <String> -Credential <VMMCredential> [-JobVariable <String>] [-PROTipID <Guid>]
 [-RunAsynchronously] [-VMMServer <ServerConnection>] [<CommonParameters>]

Description

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

Examples

Example 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.

Parameters

-ComputerName

Specifies the name of a computer that VMM can uniquely identify on your network. The acceptable values for this parameter are:

- FQDN

  • IPv4 or IPv6 address
  • NetBIOS name

Type:String
Required:True
Position:0
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Credential

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.

Type:VMMCredential
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-JobVariable

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

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PROTipID

Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.

Type:Guid
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RunAsynchronously

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

Type:SwitchParameter
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VMMServer

Specifies a VMM server object.

Type:ServerConnection
Required:False
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Outputs

PXEServer

This cmdlet returns a **PXEServer** object.