New-WdsClient
New-WdsClient
Creates a pre-staged client.
構文
Parameter Set: BasicParams
New-WdsClient -DeviceID <String> -DeviceName <String> [-AsJob] [-BootImagePath <String> ] [-CimSession <CimSession[]> ] [-Domain <String> ] [-Group <String> ] [-JoinDomain <Boolean> ] [-OU <String> ] [-PxePromptPolicy <PxePromptPolicy> ] [-ReferralServer <String> ] [-ThrottleLimit <Int32> ] [-WdsClientUnattend <String> ] [ <CommonParameters>]
Parameter Set: UserAndJoinRights
New-WdsClient -DeviceID <String> -DeviceName <String> -JoinRights <JoinRights> -User <String> [-AsJob] [-BootImagePath <String> ] [-CimSession <CimSession[]> ] [-Domain <String> ] [-Group <String> ] [-JoinDomain <Boolean> ] [-OU <String> ] [-PxePromptPolicy <PxePromptPolicy> ] [-ReferralServer <String> ] [-ThrottleLimit <Int32> ] [-WdsClientUnattend <String> ] [ <CommonParameters>]
詳細説明
The New-WdsClient cmdlet creates a pre-staged client, which is an account for a computer within Active Directory® ドメイン サービス (AD DS). Use pre-staged clients to provision computer accounts before a server that runs Windows Deployment Services installs a version of the Windows operating system on the computer. To create a pre-staged client, specify the GUID, media access control (MAC) address, or Dynamic Host Configuration Protocol (DHCP) identifier associated with the computer, and a name for the computer.
You can also specify the following:
-- 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.
-- If Windows Deployment Services server is domain joined, the domain and organizational unit (OU) in which to create the computer account. If you do not specify this information, the cmdlet creates the account in the default computer container in the domain that the Windows Deployment Services server belongs to.
パラメーター
-AsJob
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-BootImagePath<String>
Specifies a path to the boot image. This is the path to the boot image file for the computer.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByValue, ByPropertyName) |
ワイルドカード文字を許可する |
false |
-CimSession<CimSession[]>
リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。
エイリアス |
Session |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
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.
エイリアス |
なし |
必須? |
true |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByValue, ByPropertyName) |
ワイルドカード文字を許可する |
false |
-DeviceName<String>
Specifies the name of the computer associated with the pre-staged client. This is a sAMAccountName value.
エイリアス |
なし |
必須? |
true |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByValue, ByPropertyName) |
ワイルドカード文字を許可する |
false |
-Domain<String>
Specifies the domain in which to create the computer account name.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByValue, ByPropertyName) |
ワイルドカード文字を許可する |
false |
-Group<String>
Specifies the group name of the client associated with the pre-staged client.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByValue, ByPropertyName) |
ワイルドカード文字を許可する |
false |
-JoinDomain<Boolean>
Indicates whether to join the computer to a domain as the account specified by the User parameter.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
TRUE |
パイプライン入力を許可する |
True (ByValue, ByPropertyName) |
ワイルドカード文字を許可する |
false |
-JoinRights<JoinRights>
Specifies the rights to assign to the account. このパラメーターに対して使用できる値:
-- 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.
エイリアス |
なし |
必須? |
true |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByValue, ByPropertyName) |
ワイルドカード文字を許可する |
false |
-OU<String>
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.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByValue, ByPropertyName) |
ワイルドカード文字を許可する |
false |
-PxePromptPolicy<PxePromptPolicy>
Specifies the prompt policy for this computer to boot in PXE. このパラメーターに対して使用できる値:
-- Adopt
-- NoPrompt
-- OptIn
-- OptOut
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByValue, ByPropertyName) |
ワイルドカード文字を許可する |
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).
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByValue, ByPropertyName) |
ワイルドカード文字を許可する |
false |
-ThrottleLimit<Int32>
このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0
を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
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.
エイリアス |
なし |
必須? |
true |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByValue, ByPropertyName) |
ワイルドカード文字を許可する |
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.
エイリアス |
なし |
必須? |
false |
位置は? |
named |
既定値 |
なし |
パイプライン入力を許可する |
True (ByValue, ByPropertyName) |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
出力
出力型は、コマンドレットによって生成されるオブジェクトの型です。
- Microsoft.Management.Infrastructure.CimInstance#MSFT_WdsClient
例
Example 1: Create a pre-staged client
This command creates a pre-staged client named TSQA031 that has the specified ID. The command specifies a boot image and an answer file. The JoinDomain parameter has a value of $False, so this computer does not join a domain.
PS C:\> New-WdsClient -DeviceID "5a7a1def-2e1f-4a7b-a792-ae5275b6ef92" -DeviceName "TSQA031" -BootImagePath "boot\x86\images\Contosox86boot.wim" -JoinDomain $False -WdsClientUnattend "WindowsDSClientUnattend\Unattend.xml"
Example 2: Create a pre-staged client that joins a domain
This command creates a pre-staged client named TSQA048 that has the specified ID. The command specifies a referral server and an opt-in PXE prompt policy. The computer belongs to the NewComputers group.
The JoinDomain parameter has a value of $True, so this computer joins the domain specified by the Domain parameter. The command assigns the user TSQADOMAIN\PattiFuller full join rights for the domain and specifies an OU for the computer.
PS C:\> New-WdsClient -DeviceID "5a7a1def-2e1f-4a7b-a792-ae5275b6ef92" -DeviceName "TSQA048" -JoinRights Full -User "TSQADOMAIN\PattiFuller" -Domain "TSQADomain.Contoso.com" -Group "NewComputers" -JoinDomain $True -OU "OU=Unit21,CN=TSQAMain,DC=Contoso,DC=com" -PxePromptPolicy OptIn -ReferralServer "WindowsDS01"