Export (0) Print
Expand All

Set-WdsClient

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Set-WdsClient

Modifies a pre-staged client device.

Syntax

Parameter Set: DeviceName
Set-WdsClient -DeviceName <String> [-AsJob] [-BootImagePath <String> ] [-CimSession <CimSession[]> ] [-DeviceID <String> ] [-Group <String> ] [-JoinDomain <Boolean> ] [-PxePromptPolicy <PxePromptPolicy> ] [-ReferralServer <String> ] [-ResetAccount] [-ThrottleLimit <Int32> ] [-WdsClientUnattend <String> ] [ <CommonParameters>]

Parameter Set: Domain
Set-WdsClient -DeviceName <String> -Domain [-AsJob] [-BootImagePath <String> ] [-CimSession <CimSession[]> ] [-DeviceID <String> ] [-DomainName <String> ] [-Group <String> ] [-JoinDomain <Boolean> ] [-PxePromptPolicy <PxePromptPolicy> ] [-ReferralServer <String> ] [-ResetAccount] [-ThrottleLimit <Int32> ] [-WdsClientUnattend <String> ] [ <CommonParameters>]

Parameter Set: SearchForest
Set-WdsClient -DeviceName <String> -SearchForest [-AsJob] [-BootImagePath <String> ] [-CimSession <CimSession[]> ] [-DeviceID <String> ] [-Group <String> ] [-JoinDomain <Boolean> ] [-PxePromptPolicy <PxePromptPolicy> ] [-ReferralServer <String> ] [-ResetAccount] [-ThrottleLimit <Int32> ] [-WdsClientUnattend <String> ] [ <CommonParameters>]

Parameter Set: UserAndJoinRights
Set-WdsClient -DeviceName <String> -JoinRights <JoinRights> -User <String> [-AsJob] [-BootImagePath <String> ] [-CimSession <CimSession[]> ] [-DeviceID <String> ] [-Group <String> ] [-JoinDomain <Boolean> ] [-PxePromptPolicy <PxePromptPolicy> ] [-ReferralServer <String> ] [-ResetAccount] [-ThrottleLimit <Int32> ] [-WdsClientUnattend <String> ] [ <CommonParameters>]

Parameter Set: UserAndJoinRightsDomain
Set-WdsClient -DeviceName <String> -Domain -JoinRights <JoinRights> -User <String> [-AsJob] [-BootImagePath <String> ] [-CimSession <CimSession[]> ] [-DeviceID <String> ] [-DomainName <String> ] [-Group <String> ] [-JoinDomain <Boolean> ] [-PxePromptPolicy <PxePromptPolicy> ] [-ReferralServer <String> ] [-ResetAccount] [-ThrottleLimit <Int32> ] [-WdsClientUnattend <String> ] [ <CommonParameters>]

Parameter Set: UserAndJoinRightsSearchForest
Set-WdsClient -DeviceName <String> -JoinRights <JoinRights> -SearchForest -User <String> [-AsJob] [-BootImagePath <String> ] [-CimSession <CimSession[]> ] [-DeviceID <String> ] [-Group <String> ] [-JoinDomain <Boolean> ] [-PxePromptPolicy <PxePromptPolicy> ] [-ReferralServer <String> ] [-ResetAccount] [-ThrottleLimit <Int32> ] [-WdsClientUnattend <String> ] [ <CommonParameters>]




Detailed Description

The Set-WdsClient cmdlet modifies a pre-staged client device. Specify the client to modify by using its name. You can specify a client within AD DS domain of the server that runs Windows Deployment Services, within a specified domain, or anywhere in the current AD DS forest.

You can modify the following:

-- The device ID, which is a GUID, media access control (MAC) address, or Dynamic Host Configuration Protocol (DHCP) identifier associated with the computer.
-- A server that runs Windows Deployment Services. The client contacts this server for the network boot program and boot image.
-- Whether the client prompts the user to boot in the Pre-Boot Execution Environment (PXE).
-- A boot image for the client.
-- A Windows Deployment Services answer file for the client.
-- Whether the client joins a domain, the user account that joins the computer to the domain, and the join rights to granted to that user.

You can also reset the computer account, which allows anyone granted appropriate permissions to join the computer to the domain again.

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-BootImagePath<String>

Specifies a path to the boot image. This is the path to the boot image file for the computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

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


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DeviceID<String>

Specifies the ID of the computer. This identifier is the GUID of a network interface card, a MAC address, or a DHCP unique identifier associated with the computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-DeviceName<String>

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


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Domain

Indicates that the cmdlet refers to pre-staged clients within the domain specified by the DomainName parameter, instead of the domain of the server that runs Windows Deployment Services or the entire forest.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DomainName<String>

Specifies a domain name. Specify a value for this parameter only if you specify the Domain parameter.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Group<String>

Specifies the group name of the client associated with the pre-staged client.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-JoinDomain<Boolean>

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


Aliases

none

Required?

false

Position?

named

Default Value

TRUE

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

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


Aliases

none

Required?

true

Position?

named

Default Value

TRUE

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-PxePromptPolicy<PxePromptPolicy>

Specifies the prompt policy for this computer to boot in PXE. The acceptable values for this parameter are: 

-- Adopt
-- NoPrompt
-- OptIn
-- OptOut


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-ReferralServer<String>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-ResetAccount

Indicates that the cmdlet resets the permissions on the computer so that anyone granted appropriate permissions can join the domain using the account specified by the User parameter.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-SearchForest

Indicates that the cmdlet refers to pre-staged devices in the current AD DS forest. If you do not specify this parameter and do not specify the Domain parameter, the cmdlet looks for pre-staged devices in the local domain.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-User<String>

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WdsClientUnattend<String>

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, choosing an install image, and configuring the disk.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance#MSFT_WdsClient

Examples

Example 1: Modify a pre-staged client in the current AD DS domain

This command modifies a pre-staged client named TSQA087. The command specifies a boot image file, a device ID, and a referral server. The command changes the prompt policy to opt-out. The command specifies the ResetAccount parameter, so the command resets permissions so that anyone granted appropriate permissions can join the domain. The command also specifies an answer file named Unattend.xml.


PS C:\> Set-WdsClient -DeviceName "TSQA087" -BootImagePath "boot\x86\images\Contosox86boot.wim" -DeviceID "5a7a1def-2e1f-4a7b-a792-ae5275b6ef92" -PxePromptPolicy OptOut -ReferralServer "WindowsDS07" -ResetAccount -WdsClientUnattend "WindowsDSClientUnattend\Unattend.xml"

Example 2: Modify a pre-staged client in the current AD DS domain

This command modifies a pre-staged client named TSQA103. The command specifies the Domain parameter to indicate that the client belongs a specified domain, named TSQA.Contoso.com. The command adds the client to the group named 2013Purchases. The command changes the prompt policy to no prompt. The command includes the JoinDomain parameter, so the computer joins adomain.


PS C:\> Set-WdsClient -DeviceName "TSQA103" -Domain -DomainName "TSQA.Contoso.com" -Group "2013Purchases" -JoinDomain $True -PxePromptPolicy NoPrompt

Example 3: Modify a pre-staged client in the current AD DS forest

This command modifies specifies a boot image file for the pre-staged client named TSQA108. The SearchForest parameter indicates the cmdlet can find that computer in any domain in the current AD DS forest.


PS C:\> Set-WdsClient -DeviceName "TSQA108" -SearchForest -BootImagePath "boot\x86\images\Contosox86boot.wim"

Example 4: Modify join rights and user

This command modifies a pre-staged client named TSQA117. The command specifies a user named TSQADOMAIN\PattiFuller, and assigns JoinOnly rights for that user. The command also specifies boot image and a referral server.


PS C:\> Set-WdsClient -DeviceName "TSQA117" -JoinRights JoinOnly -User "TSQADOMAIN\PattiFuller" -BootImagePath "boot\x86\images\Contosox86boot.wim" -ReferralServer "WindowsDS07"

Example 5: Modify join rights, user, and prompt policy

This command modifies a pre-staged client named TSQA121. The command specifies a user named TSQADOMAIN\PattiFuller Unlike the previous example, the command assigns the user full join rights. The command specifies opt-in as the prompt policy.


PS C:\> Set-WdsClient -DeviceName "TSQA121" -Domain -JoinRights Full -User "TSQADOMAIN\PattiFuller" -PxePromptPolicy OptIn

Example 6: Modify join rights, user, and prompt policy for a client in the current AD DS forest

This command modifies a pre-staged client named TSQA128. The SearchForest parameter indicates the cmdlet can find that computer could be in any domain in the current AD DS forest.

The command specifies a value of $True for the JoinDomain parameter, so the cmdlet joins the computer to a domain. The command specifies a user named TSQADOMAIN\PattiFuller, and assigns JoinOnly rights for that user. The command also specifies the ResetAccount parameter, so the command resets permissions so that anyone granted appropriate permissions can join the domain.

This command also assigns an ID to the client by using the DeviceID parameter. The command also specifies an answer file named Unattend.xml.


PS C:\> Set-WdsClient -DeviceName "TSQA128" -JoinRights JoinOnly -SearchForest -User "TSQADOMAIN\PattiFuller" -DeviceID "5a7a1def-2e1f-4a7b-a792-ae5275b6ef92" -JoinDomain $True -ResetAccount -WdsClientUnattend "WindowsDSClientUnattend\Unattend.xml"

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft