Configures the settings for a Windows Deployment Services server.

Syntax

WDSUTIL [Options] /Set-Server [/Server:<Server name>]
    [/Authorize:{Yes | No}]
    [/RogueDetection:{Yes | No}]
    [/AnswerClients:{All | Known | None}]
    [/ResponseDelay:<Time in seconds>]
    [/AllowN12ForNewClients:{Yes | No}]
    [/ArchitectureDiscovery:{Yes | No}]
    [/ResetBootProgram:{Yes | No}]
    [/DefaultX86X64ImageType:{x86 | x64 | Both}]
    [/UseDhcpPorts:{Yes | No}]
    [/DhcpOption60:{Yes | No}]
    [/RpcPort:<Port number>]
    [/BootProgram:<Relative path>]
         /Architecture:{x86 | ia64 | x64}
    [/N12BootProgram:<Relative path>]
         /Architecture:{x86 | ia64 | x64}
    [/BootImage:<Relative path>]
         /Architecture:{x86 | ia64 | x64}
    [/PreferredDC:<DC Name>]
    [/PreferredGC:<GC Name>]
    [/PrestageUsingMAC:{Yes | No}]
    [/NewMachineNamingPolicy:<Policy>]
    [/NewMachineOU]
         [/Type:{ServerDomain | UserDomain | UserOU | Custom}]
         [/OU:<Domain name of OU>]
    [/DomainSearchOrder:{GCOnly | DCFirst}]
    [/NewMachineDomainJoin:{Yes | No}]
    [/OSCMenuName:<Name>]
    [/WdsClientLogging]
         [/Enabled:{Yes | No}]
         [/LoggingLevel:{None | Errors | Warnings | Info}]
    [/WdsUnattend]
         [/Policy:{Enabled | Disabled}]
         [/CommandlinePrecedence:{Yes | No}]
         [/File:<Path>]
             /Architecture:{x86 | ia64 | x64}
    [/AutoAddPolicy]
         [/Policy:{AdminApproval | Disabled}]
         [/PollInterval:{Time in seconds}]
         [/MaxRetry:{Retries}]
         [/Message:<Message>]
         [/RetentionPeriod]
             [/Approved:<Time in days>]
             [/Others:<Time in days>]
    [/AutoAddSettings]
         /Architecture:{x86 | ia64 | x64}
         [/BootProgram:<Relative path>]
         [/ReferralServer:<Server name>
         [/WdsClientUnattend:<Relative path>]
         [/BootImage:<Relative path>]
         [/User:<Owner>]
         [/JoinRights:{JoinOnly | Full}]
         [/JoinDomain:{Yes | No}]
    [/BindPolicy]
         [/Policy:{Include | Exclude}]
         [/Add]
              /Address:<IP or MAC address>
              /AddressType:{IP | MAC}
         [/Remove]
              /Address:<IP or MAC address>
              /AddressType:{IP | MAC}
    [/RefreshPeriod:<Time in seconds>]
    [/BannedGuidPolicy]
         [/Add]
              /Guid:<GUID>
         [/Remove]
             /Guid:<GUID>
    [/BcdRefreshPolicy]
         [/Enabled:{Yes | No}]
         [/RefreshPeriod:<Time in minutes>]

    [/Transport]
         [/ObtainIpv4From:{Dhcp | Range}]
             [/Start:<Start Ip Address>]
             [/End:<End Ip Address>]
         [/StartPort:<Start Port>
             [/EndPort:<Start Port>
         [/Profile:{10Mbps | 100Mbps | 1Gbps | Custom}]
    [/ForceNative]

Parameters

Parameter Description

[/Server:<Server name>]

Specifies the name of the server. This can be either the NetBIOS name or the fully qualified domain name (FQDN). If no server name is specified, the local server will be used.

[/Authorize:{Yes | No}]

Sets the authorization mode of the server in Dynamic Host Control Protocol (DHCP).

[/RogueDetection:{Yes | No}]

Enables or disables DHCP rogue detection.

[/AnswerClients:{All | Known | None}]

Sets the answer mode for the Pre-Boot Execution Environment (PXE) server. If you set this value to Known, a device must be prestaged before it will be answered.

[/ResponseDelay:<Time in seconds>]

The amount of time that a PXE Server must wait before answering a booting client. This setting does not apply to prestaged devices.

[/AllowN12ForNewClients:{Yes | No}]

Specifies that any unknown client will receive a boot program that does not require the user to press the F12 key to initiate a network boot. Known clients will receive the boot program specified for the devices or, if not specified, the server for the server.

[/ArchitectureDiscovery:{Yes | No}]

Enables or disables the network boot program for architecture discovery. This facilitates the discovery of x64-based clients that do not broadcast their architecture correctly.

[/ResetBootProgram:{Yes | No}]

Determines whether the boot path will be erased for a client that has just booted without requiring an F12 key press.

[/DefaultX86X64ImageType: {x86 | x64 | Both}]

Controls which boot images will be shown to x64-based clients.

[/UseDhcpPorts:{Yes | No}]

Specifies whether or not the PXE server should attempt to bind to the DHCP port, TCP port 67. If DHCP and Windows Deployment Services are running on the same computer, you should set this option to No to enable the DHCP server to utilize the port, and set the /DhcpOption60 parameter to Yes. The default setting for this value is Yes.

[/DhcpOption60:{Yes | No}]

Specifies whether DHCP option 60 should be configured for PXE support. If DHCP and Windows Deployment Services are running on the same server, set this option to Yes and set the /UseDhcpPorts option to No. The default setting for this value is No.

[/RpcPort:<Port number>]

Specifies the TCP port number to be used to service client requests.

[/BootProgram:<Relative path>] /Architecture:{x86 | ia64 | x64}

Specifies the relative path to the boot program in the RemoteInstall folder (for example, boot\x86\pxeboot.n12), and specifies the architecture of the boot program.

[/N12BootProgram:<Relative path>] /Architecture:{x86 | ia64 | x64}

Specifies the relative path to the boot program that does not require pressing the F12 key (for example, boot\x86\pxeboot.n12), and specifies the architecture of the boot program.

[/BootImage:<Relative path>] /Architecture:{x86 | ia64 | x64}

Specifies the relative path to the boot image that booting clients should receive, and specifies the architecture of the boot image.

[/PreferredDC:<DC Name>]

Specifies the name of the domain controller that Windows Deployment Services PXE Provider (BINL) should use. This can be either the NetBIOS name or the FQDN.

[/PreferredGC:<GC Name>]

Specifies the name of the global catalog server that Windows Deployment Services PXE Provider (BINL) should use. This can be either the NetBIOS name or the FQDN.

[/PrestageUsingMAC:{Yes | No}]

Specifies whether Windows Deployment Services, when creating computer accounts in the directory service, should use the MAC address rather than the GUID/UUID as the known identifier for the device.

[/NewMachineNamingPolicy:<Policy>]

Specifies the format to be used when generating client computer names.

[/NewMachineOU]

Specifies the location in the directory service where client computer accounts will be created.

Parameter Description

[/Type:ServerDomain|UserDomain|UserOU|Custom]

  • ServerDomain creates client computer accounts in the computer container for the directory service domain that contains the Windows Deployment Services server.

  • UserDomain creates client computers in the computer container for the directory service domain of the user that is performing the client installation.

  • UserOU creates client computers in the same directory service location as the user that is performing the client computer installation.

  • Custom specifies the location in the directory service where client computer accounts will be created. If you use this option, you must also specify a value for /OU.

[/OU:<Domain name of OU>]

If you specify Custom for the /Type option, this option specifies the organizational unit where computer accounts should be created.

[/DomainSearchOrder:{GCOnly | DCFirst}]

Specifies the policy for searching computer accounts in the directory service (global catalog or domain controller).

[/NewMachineDomainJoin:{Yes | No}]

Specifies whether or not a new computer (for example, one that is not already prestaged in Active Directory Domain Services) should be joined to the domain during installation. The default setting is Yes.

[/WdsClientLogging]

Specifies the logging level for the server.

Parameter Description

[/Enabled:{Yes | No}]

Enables or disables logging of Windows Deployment Services client actions.

[/LoggingLevel: {None | Errors | Warnings | Info}

Sets the logging level.

  • None is equivalent to disabling logging.

  • Errors is the lowest level of logging and indicates that only errors will be logged.

  • Warnings includes both warnings and errors.

  • Info is the highest level of logging and includes errors, warnings, and informational events.

[/WdsUnattend]

These settings control the unattended installation behavior of Windows Deployment Services client.

Parameter Description

[/Policy:{Enabled | Disabled}]

Specifies whether or not unattended installation is used.

[/CommandlinePrecedence:{Yes | No}]

Specifies whether an autounattend.xml file (if present on the client) or an unattended setup file that was passed directly to the Windows Deployment Services client with the /Unattend switch will be used instead of an image unattend file during a client installation. The default setting is No.

[/File:<Relative path>]

Specifies the file name and path of the unattend file.

[/Architecture:{x86 | ia64 | x64}]

Specifies the architecture of the unattend file. You must use this option with /File.

[/AutoAddPolicy]

These settings control the Auto-Add policy.

Parameter Description

[/Policy:{AdminApproval | Disabled}]

Specifies the Auto-Add mode.

  • AdminApprove causes all unknown devices to be added to a pending queue, where the administrator can then review the list of devices and approve or reject each request, as appropriate.

  • Disabled indicates that no additional action is taken when an unknown device attempts to boots to the server.

[/PollInterval:{Time in seconds}]

Specifies the interval (in seconds) at which the network boot program should poll the Windows Deployment Services server.

[/MaxRetry:<Retries>]

Specifies the number of times the network boot program should poll the Windows Deployment Services server. This value, along with /PollInterval, dictates how long the network boot program will wait for an administrator to approve or reject the device before timing out. For example, a MaxRetry value of 10 and a PollInterval value of 60 would indicate that the client should poll the server 10 times, waiting 60 seconds between tries. Therefore, the client would time out after 10 minutes (10 x 60 seconds = 10 minutes).

[/Message:<Message>]

Specifies the message that is displayed to the client on the network boot program dialog page.

[/RetentionPeriod]

Specifies the number of days a device can remain in the Pending Devices table before being automatically purged.

[/Approved:<Time in days>]

Specifies the retention period for approved devices. You must use this parameter with the /RetentionPeriod option.

[/Others:<Time in days>]

Specifies the retention period for unapproved devices (rejected or pending). You must use this parameter with the /RetentionPeriod option.

[/AutoAddSettings]

Specifies the default settings to be applied to each device.

Parameter Description

/Architecture:{x86 | ia64 | x64}

Specifies the architecture.

[/BootProgram:<Relative path>]

Specifies the boot program sent to the approved device. If no boot program is specified, the default server for the approved device architecture will be used.

[/WdsClientUnattend:<Relative path>]

Sets the relative path to the unattend file that the approved client should receive.

[/ReferralServer:<Server name>]

Specifies the Windows Deployment Services server that the client will use to download images.

[/BootImage:<Relative path>]

Specifies the boot image that the approved client will receive.

[/User:<Domain\User | User@Domain>]

Sets permissions on the computer account object to give the specified user the necessary rights to join the device to the domain.

[/JoinRights:{JoinOnly | Full}]

Specifies the type of rights to be assigned to the user.

  • JoinOnly requires the administrator to reset the computer account before the user can join the computer to the domain.

  • Full gives full access to the user, including the right to join the computer to the domain.

[/JoinDomain:{Yes | No}]

Specifies whether or not the device should be joined to the domain as this computer account during a Windows Deployment Services installation. The default setting is Yes.

[/BindPolicy]

Configures the server interface bind policy.

Parameter Description

[/Policy:{Include | Exclude}]

Sets the interface bind policy to include or exclude the addresses on the interface list.

[/Add]

Adds an interface to the list.

[/Remove]

Removes an interface from the list.

/Address:<IP or MAC address>

Specifies the IP or MAC address of the interface. You must use this option with /Add or /Remove.

/AddressType:{IP | MAC}

Indicates the type of address specified in the /Address option. You must use this option with /Add or /Remove .

[/RefreshPeriod:<Time in seconds>]

Specifies the interval at which the server will update its configuration settings.

[/BannedGuidPolicy]

Manages the list of banned GUIDs using the options in the following table:

Parameter Description

[/Add] /Guid:<GUID>

Adds the specified GUID to the list of banned GUIDs. Any client with this GUID will be identified by its MAC address instead.

[/Remove] /Guid:<GUID>

Removes the specified GUID from the list of banned GUIDs.

[/BcdRefreshPolicy]

Configures the settings for refreshing BCD files as specified in the following table:

Parameter Description

[/Enabled:{Yes | No}]

Specifies the BCD refreshing policy. When /Enabled is set to Yes, BCD files are refreshed at the specified time interval.

[/RefreshPeriod:<Time in minutes>]

Specifies the time interval at which BCD files are refreshed.

[/Transport]

Configures settings used by the Transport Server as specified in the following table:

Parameter Description

[/ObtainIpv4From:{Dhcp | Range}]

Specifies the source of IPv4 addresses.

[/Start:<Starting Ipv4 address>]

Specifies the start of the IP address range. This option is required and valid only if /ObtainIpv4From is set to Range.

[/End:<Ending Ipv4 address>]

Specifies the end of the IP address range. This option is required and valid only if /ObtainIpv4From is set to Range.

[/StartPort:<Starting port>]

Specifies the start of the port range.

[/EndPort:<Ending port>]

Specifies the end of the port range.

[/Profile: {10Mbps | 100Mbps | 1Gbps | Custom}]

Specifies the network profile to be used.

Examples

To set the server to answer only known clients, with a response delay of 4 minutes, type:

WDSUTIL /Set-Server /AnswerClients:Known /ResponseDelay:4

To set the boot program and architecture for the server, type:

WDSUTIL /Set-Server /BootProgram:boot\x86\pxeboot.n12 /Architecture:x86

To enable logging on the server, type:

WDSUTIL /Set-Server /WdsClientLogging /Enabled:Yes /LoggingLevel:Warnings

To enable unattend on the server, as well as the architecture and the client unattend file, type:

WDSUTIL /Set-Server /WdsUnattend /Policy:Enabled /File:WDSClientUnattend \unattend.xml /Architecture:x86

To set the Pre-Boot Execution Environment (PXE) server to attempt to bind to TCP ports 67 and 60, type:

WDSUTIL /Set-server /UseDhcpPorts:No /DhcpOption60:Yes

Converted from CHM to HTML with chm2web Pro 2.85 (unicode)