Edit

Share via

Approve-WdsClient

Module:
WDS Module

Approves clients.

Syntax

SingleMachineUserAndJoinRights 

Approve-WdsClient
    -JoinRights <JoinRights>
    -User <String>
    -RequestId <UInt32>
    [-BootImagePath <String>]
    [-BootProgram <String>]
    [-JoinDomain <Boolean>]
    [-OU <String>]
    [-ReferralServer <String>]
    [-WdsClientUnattend <String>]
    [-DeviceName <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

SingleMachine 

Approve-WdsClient
    -RequestId <UInt32>
    [-BootImagePath <String>]
    [-BootProgram <String>]
    [-JoinDomain <Boolean>]
    [-OU <String>]
    [-ReferralServer <String>]
    [-WdsClientUnattend <String>]
    [-DeviceName <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

MultipleMachineUserAndJoinRights 

Approve-WdsClient
    -JoinRights <JoinRights>
    -User <String>
    [-BootImagePath <String>]
    [-BootProgram <String>]
    [-JoinDomain <Boolean>]
    [-OU <String>]
    [-ReferralServer <String>]
    [-WdsClientUnattend <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

MultipleMachine 

Approve-WdsClient
    [-BootImagePath <String>]
    [-BootProgram <String>]
    [-JoinDomain <Boolean>]
    [-OU <String>]
    [-ReferralServer <String>]
    [-WdsClientUnattend <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

Description

The Approve-WdsClient cmdlet approves clients that need administrative approval. Unknown clients require approval before the server that runs Windows Deployment Services boots the client in the Pre-Boot Execution Environment (PXE). You can specify a single device to approve by using a request ID. The server that runs Windows Deployment Services allocates a request ID to a device. If you do not specify a client to approve, the cmdlet approves all pending clients.

At the time that you approve an unknown client, you can also modify settings for the client. Use the New-WdsClient and Set-WdsClient cmdlets to create and modify pre-staged clients.

Examples

Example 1: Approve all pre-staged clients and modify settings

PS C:\> Approve-WdsClient -BootImagePath "boot\x86\images\Contosox86boot.wim" -BootProgram "boot\x86\PxeBoot.com" -JoinDomain $True -OU "OU=Unit21,CN=TSQAMain,DC=Contoso,DC=com" -ReferralServer "WindowsDS01" -WdsClientUnattend "WindowsDSClientUnattend\Unattend.xml"

This command approves all pending pre-staged clients. The command also specifies a boot image, boot program, and referral server. The PXE boot process refers to the answer file specified by the WdsClientUnattend parameter.

The JoinDomain parameter has a value of $True, so these computers join a domain. The command specifies an OU for the computers.

Example 2: Approve all pre-staged clients and specify a user

PS C:\> Approve-WdsClient -JoinRights JoinOnly -User "TSQADOMAIN\PattiFuller" -BootImagePath "boot\x86\images\Contosox86boot.wim" -BootProgram "boot\x86\PxeBoot.com" -JoinDomain $True -OU "OU=Unit21,CN=TSQAMain,DC=Contoso,DC=com"

This command approves all pending pre-staged clients. The command also specifies a boot image and boot program.

The JoinDomain parameter has a value of $True, so these computers join a domain. The command specifies the user TSQADOMAIN\PattiFuller and specifies an OU for the computers.

Example 3: Approve a pre-staged client

PS C:\> Approve-WdsClient -RequestId 7 -DeviceName "TSQA004"

This command approves a pre-staged client that has a request ID of seven, and assigns the device name TSQA004.

Example 4: Approve a pre-staged client and modify settings

PS C:\> Approve-WdsClient -JoinRights Full -RequestId 22 -User "ITAdmin01@TSQADomain.Contoso.com" -BootImagePath "boot\x86\images\Contosox86boot.wim" -BootProgram "boot\x86\PxeBoot.com" -DeviceName "TSQA009" -JoinDomain $True -OU "OU=Unit21,CN=TSQAMain,DC=Contoso,DC=com"

This command approves a pre-staged client that has a request ID of 22 and assigns the device name TSQA009. The command also specifies a boot image and boot program.

The JoinDomain parameter has a value of $True, so this computer joins a domain. The command specifies the user ITAdmin01@TSQADomain.Contoso.com and specifies an OU for the computer. The user has full join rights.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BootImagePath

Specifies a path of the boot image. This is a relative path from the RemoteInstall share to the boot image file for the computer.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BootProgram

Specifies the relative path from the RemoteInstall share to the network boot program for the computer.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DeviceName

Specifies the name of the computer associated with the pre-staged client. This is a sAMAccountName value.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SingleMachineUserAndJoinRights
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
SingleMachine
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-JoinDomain

Indicates whether to join the computer to a domain as the account specified by the User parameter.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-JoinRights

Specifies the rights to assign to the account. The acceptable values for this parameter are:

  • Full. Assigns full access rights, which includes the right to join the computer to the domain at any time.
  • JoinOnly. Requires the administrator to reset the computer account before the user can join the computer to the domain.

Parameter properties

Type:JoinRights
Default value:None
Accepted values:JoinOnly, Full
Supports wildcards:False
DontShow:False

Parameter sets

SingleMachineUserAndJoinRights
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
MultipleMachineUserAndJoinRights
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OU

Specifies the distinguished name of an OU. The cmdlet creates the computer account object in this location. If you do not specify this parameter, Windows Deployment Services creates the account in the default computer container in the domain of the server that runs Windows Deployment Services.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReferralServer

Specifies the name of a server. If you specify a referral server, the computer connects to this Windows Deployment Services server to download the network boot program and boot image by using Trivial File Transfer Protocol (TFTP).

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RequestId

Specifies the request ID that the server that runs Windows Deployment Services allocates to a device in the Pending Device database. If you do not specify this parameter, the cmdlet approves all clients in the Pending Device database.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SingleMachineUserAndJoinRights
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False
SingleMachine
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-User

Specifies a user, in the format DOMAIN\User or User@Domain. If you specify a value of $True for the JoinDomain parameter, the cmdlet assigns the user the right to join the computer to the domain specified by the Domain parameter. To join the client computer to the specified domain without granting any user rights, specify a value of $True for the JoinDomain parameter, but do not specify a user.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SingleMachineUserAndJoinRights
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
MultipleMachineUserAndJoinRights
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WdsClientUnattend

Specifies an answer file as a relative path from the RemoteInstall share. This file contains information for the Windows Deployment Services client user interface screens, such as entering credentials, selecting an install image, and configuring the disk.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

CimInstance