Set-WdsClient
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>]
Detaillierte Beschreibung
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.
Parameter
-AsJob
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-BootImagePath<String>
Specifies a path to the boot image. This is the path to the boot image file for the computer.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByValue, ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-CimSession<CimSession[]>
Führt das Cmdlet in einer Remotesitzung oder auf einem Remotecomputer aus. Geben Sie einen Computernamen oder ein Sitzungsobjekt ein, z. B. die Ausgabe eines Cmdlets New-CimSession oder Get-CimSession. Der Standardwert ist die aktuelle Sitzung auf dem lokalen Computer.
Aliasse |
Session |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
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.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByValue, ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-DeviceName<String>
Specifies the name of the computer associated with the pre-staged client. This is a sAMAccountName value.
Aliasse |
Keiner |
Erforderlich? |
true |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
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.
Aliasse |
Keiner |
Erforderlich? |
true |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-DomainName<String>
Specifies a domain name. Specify a value for this parameter only if you specify the Domain parameter.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-Group<String>
Specifies the group name of the client associated with the pre-staged client.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByValue, ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-JoinDomain<Boolean>
Indicates whether to join the computer to a domain as the account specified by the User parameter.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
TRUE |
Pipelineeingaben akzeptieren? |
True (ByValue, ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-JoinRights<JoinRights>
Specifies the rights to assign to the account. Die folgenden Werte für diesen Parameter sind zulässig:
-- 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.
Aliasse |
Keiner |
Erforderlich? |
true |
Position? |
named |
Standardwert |
TRUE |
Pipelineeingaben akzeptieren? |
True (ByValue, ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
-PxePromptPolicy<PxePromptPolicy>
Specifies the prompt policy for this computer to boot in PXE. Die folgenden Werte für diesen Parameter sind zulässig:
-- Adopt
-- NoPrompt
-- OptIn
-- OptOut
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByValue, ByPropertyName) |
Platzhalterzeichen akzeptieren? |
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).
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByValue, ByPropertyName) |
Platzhalterzeichen akzeptieren? |
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.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByValue, ByPropertyName) |
Platzhalterzeichen akzeptieren? |
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.
Aliasse |
Keiner |
Erforderlich? |
true |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-ThrottleLimit<Int32>
Gibt die maximale Anzahl von gleichzeitigen Vorgängen an, die zum Ausführen dieses Cmdlets eingerichtet werden können. Wenn dieser Parameter ausgelassen oder der Wert 0 eingegeben wird, berechnet Windows PowerShell® einen optimalen Drosselungsgrenzwert für das Cmdlet basierend auf der Anzahl der CIM-Cmdlets, die auf dem Computer ausgeführt werden. Die Drosselungsgrenze gilt nur für das aktuelle Cmdlet und nicht für die Sitzung oder den Computer.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
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.
Aliasse |
Keiner |
Erforderlich? |
true |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
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.
Aliasse |
Keiner |
Erforderlich? |
false |
Position? |
named |
Standardwert |
Keiner |
Pipelineeingaben akzeptieren? |
True (ByValue, ByPropertyName) |
Platzhalterzeichen akzeptieren? |
false |
<CommonParameters>
Dieses Cmdlet unterstützt die allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, -OutVariable. Weitere Informationen finden Sie unter about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Eingaben
Der Eingabetyp ist der Typ der Objekte, die über die Pipeline an das Cmdlet übergeben werden können.
Ausgaben
Der Ausgabetyp ist der Typ der Objekte, die vom Cmdlet ausgegeben werden.
- Microsoft.Management.Infrastructure.CimInstance#MSFT_WdsClient
Beispiele
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"