Netsh Commands for Dynamic Host Configuration Protocol server

Article
07/02/2012

Applies To: Windows Server 2008

The Netsh commands for Dynamic Host Configuration Protocol (DHCP) server offer a command-line tool that helps with the administration of DHCP servers and provides an equivalent alternative to console-based management. This can be useful in the following situations:

When managing DHCP servers in wide area networks (WANs), commands can be used in interactive mode at the Netsh command prompt to better manage across slow-speed network links.
When managing a large number of DHCP servers, commands can be used in batch mode at the Netsh command prompt to help script and automate recurring administrative tasks that need to be performed for all DHCP servers.

You can run these commands from the command prompt for the Netsh DHCP context. For these commands to work at the command prompt, you must type netsh dhcp before typing commands and parameters as they appear in the syntax below.

For an example of how to use Netsh commands for DHCP in batch files and scripts, see Netsh DHCP Example.

For more information about netsh, see Netsh Overview and Enter a Netsh Context.

This section contains commands in the following contexts.

Netsh DHCP
Netsh DHCP server
Netsh DHCP server V4
Netsh DHCP server V6 in Windows Server 2008
Netsh DHCP server V6 in Windows Server 2008
Netsh DHCP server scope
Netsh DHCP server mscope

For information on how to interpret netsh command syntax, see Formatting Legend.

Netsh commands for DHCP

The following entries provide details for each command.

Netsh DHCP

The following commands are available at the dhcp> prompt, which is rooted within the netsh environment.

To view the command syntax, click a command:

add server
delete server
server
show server

add server

Adds a DHCP server to the list of authorized servers in Active Directory.

Syntax

add server serverDNS serverIP

Parameters

ServerDNS
Required. Specifies the DHCP server to add. Identifies the server by DNS domain name.

ServerIP
Required. Specifies the DHCP server to add. Identifies the server by IP address.

Examples

In the following example, this command adds a server with the DNS name dhcpsrv1.example.microsoft.com and IP address 10.2.2.2 to the list of authorized servers in Active Directory®.

add server dhcpsrv1.example.microsoft.com 10.2.2.2

delete server

Deletes a DHCP server from the list of authorized servers in Active Directory.

Syntax

delete server ServerDNS ServerIP

Parameters

ServerDNS
Required. Specifies the DHCP server to delete. Identifies the server by DNS domain name.

ServerIP
Required. Specifies the DHCP server to delete. Identifies the server by IP address.

Examples

In the following example, this command deletes the server with the DNS name dhcpsrv1.example.microsoft.com and IP address 10.2.2.2 from the list of authorized servers in Active Directory.

delete server dhcpsrv1.example.microsoft.com 10.2.2.2

server

Shifts the current Netsh DHCP command-line context to a different DHCP server. Used without parameters, server shifts the current command-line context to the local computer.

Syntax

server [{**\\**ServerNetBIOSName | **\\**ServerFQDN | ServerIP}]

Parameters

**{ **\\**ServerNetBIOSName| **\\ServerFQDN| ServerIP}
Specifies the DHCP server to which you want to shift the current command-line context. Identifies the server by NetBIOS name, fully qualified domain name (FQDN), or IP address.

Examples

In the first example, this command changes the Netsh DHCP command-line context to the DHCP server with the NetBIOS name \\DHCP-SRV1.

In the second example, this command changes the Netsh DHCP command-line context to the DHCP server with IP address 10.0.0.1.

In the third example, this command changes the Netsh DHCP command-line context to the DHCP server with the FQDN \\example.microsoft.com.

server \\DHCP-SRV1

server 10.0.0.1

server \\example.microsoft.com

show server

Displays a list of authorized servers in Active Directory.

Syntax

show server

Parameters

none

Netsh DHCP server

The following commands are available at the dhcp server> prompt, which is rooted within the netsh environment.

To view the command syntax, click a command:

add class
add mscope
add optiondef
add scope
backup
delete class
delete dnscredentials
delete mscope
delete optiondef
delete optionvalue
delete scope
delete superscope
dump
export
import
initiate auth
mscope
restore
scope
set auditlog
set bindings
set databasebackupinterval
set databasebackuppath
set databasecleanupinterval
set databaseloggingflag
set databasename
set databasepath
set databaserestoreflag
set detectconflictretry
set dnsconfig
set dnscredentials
set napstate
set napdeffail
set optionvalue
set server
set userclass
set vendorclass
show all
show auditlog
show bindings
show class
show detectconflictretry
show dnsconfig
show dnscredentials
show mibinfo
show mscope
show napstate
show napdeffail
show optiondef
show optionvalue
show scope
show superscope
show server
show dbproperties
show serverstatus
show userclass
show vendorclass
show version

add class

Adds a class to the specified DHCP server.

Syntax

add class ClassName [ClassComment] [Data] [[IsVendor=]{0 | 1}] [[IsBinary=]{B | b}]

Parameters

ClassName
Required. Specifies the name of the class to create.

ClassComment
Specifies the comment to associate with the class.

Data
Specifies class data in ASCII or binary format depending on the IsBinary parameter. If unspecified, it is assumed that the format of the data is ASCII.

[ IsVendor=]{0 | 1}
Indicates whether the class to add is a user class or a vendor class: 0-User class (default), 1-Vendor class.

[ IsBinary=]{B | b}
Indicates if the class data is in binary format. If unspecified, it is assumed that the format of the data is ASCII.

Examples

In the first example, this command creates a vendor class named MyClass, with the comment TestClass, and the class data TestDataForMyClass in ASCII format.

In the second example, this command creates a user class named MyUserClass with binary data of 4345335532 (ASCII-CE3U2).

The third example is an alternate command syntax for the second example.

add class MyClass TestClass TestDataForMyClass 1

add class MyUserClass TestClass1 4345335532 B

add class MyUserClass TestClass1 4345335532 0 b

add mscope

Adds a multicast scope to the specified DHCP server.

Syntax

add mscope MscopeName [MscopeComment] [TTL]

Parameters

MscopeName
Required. Specifies the name of the multicast scope to add.

MscopeComment
Specifies a description of the current multicast scope.

TTL
Specifies the Time-To-Live (TTL) value for the multicast scope. The valid range for this field is 1 to 255, with a default of 32.

Examples

In the following example, this command creates a multicast scope with the name My MultiCast Scope, a comment of MyTestMulticastScope, and a multicast TTL value of 40.

add mscope "My MultiCast Scope" MyTestMulticastScope 40

add optiondef

Adds a new option type definition to the specified DHCP server.

Syntax

add optiondef OptCode OptName{BYTE | WORD | DWORD | STRING | IPADDRESS} [[IsArray=]{0 | 1}] [**vendor=**VendorClass] [**comment=**OptComment] [DefValue]

Parameters

OptCode
Required. Specifies the option type to define. Identifies the option type with a unique option code. For the value of the code, choose a number between zero and 255.

OptName
Required. Specifies the name of the option type.

{BYTE | WORD | DWORD | STRING| IPADDRESS}
Required. Indicates the data type of the option.

[IsArray=]{0 | 1}
Indicates whether the data type is arrayed or non-arrayed: 0-Unary or non-arrayed (default), 1-Arrayed.

****vendor=VendorClass
Specifies the vendor class for the option. If unspecified, the default vendor class, the DHCP standard options class, is used.

****comment=OptComment
Specifies a comment to add to the new option type definition. If unspecified, the default value is NULL.

DefValue
Specifies a default value to use for this option type, if one is not specified otherwise.

Remarks

IsArray must be 0 for STRING type options.

Examples

In the first example, this command defines a new option type named ExtensionsPath with code 18, a STRING data type, and joins it to the DHCP standard options class, assigning it a default value of c:\Temp.

In the second and third examples, this command defines a new option type named TestOption with code 231 and an IPADDRESS data type. In the second example, the option is defined to provide only a single IP address. IsArray and DefValue are not necessary because defaults are assumed. In the third example, DefValue and IsArray are required to create an array that contains the IP address values 10.1.1.1, 10.1.1.2, and 10.1.1.3.

add optiondef 18 ExtensionsPath STRING 0 c:\Temp

add optiondef 231 TestOption IPADDRESS

add optiondef 231 TestOption IPADDRESS 1 vendor=MyVendorClass 10.1.1.1 10.1.1.2 10.1.1.3

add optiondef 231 TestOption IPV6ADDRESS 1 vendor=MyVendorClass::0A01:0101

add scope

Adds a scope to the specified DHCP server.

Syntax

add scope ScopeAddress SubnetMask ScopeName[ScopeComment]

Parameters

ScopeAddress
Required. Specifies the scope to add. Identifies the scope by IP network number.

SubnetMask
Required. Specifies the subnet mask for the scope to add.

ScopeName
Required. Specifies an identifying name for the scope.

ScopeComment
Specifies a comment for the scope.

Examples

In the following example, this command adds a scope for the DHCP server with scope address 10.2.2.0, subnet mask 255.255.255.0, a scope name of MyScope, and a scope comment of MyComment.

add scope 10.2.2.0 255.255.255.0 MyScope MyComment

backup

Performs an asynchronous backup of the DHCP database, including all scopes, reservations, leases, options, configuration settings, and registry keys. An error will be returned if the specified destination is not valid or cannot be found.

Syntax

backup [Path]

Parameters

[Path]
Specifies the path of the folder in which the backup .mdb DHCP database file will be created. If not specified, the path defaults to %systemroot%\System32\Dhcp\Backup.

Remarks

Note that if the default destination is chosen, the synchronous backup that the DHCP server creates every 60 minutes will overwrite the async backup.

Examples

In the following example, this command sets the path of the DHCP server database file to c:\MyBackUpFiles\DHCP.

backup "c:\MyBackUpFiles\DHCP”

delete class

Deletes a class from the specified DHCP server.

Syntax

delete class Name

Parameters

Name
Required. Specifies the user or vendor class to delete.

Examples

In the following example, this command deletes the class named MyClass.

delete class MyClass

delete dnscredentials

Deletes the credentials used for all DNS dynamic updates.

Syntax

delete dnscredentials dhcpforceflag

Parameters

none

delete mscope

Deletes a multicast scope from the specified DHCP server.

Syntax

delete mscope MscopeName

Parameters

MscopeName
Required. Specifies the multicast scope to delete. MscopeName is case-sensitive.

Examples

In the following example, this command deletes the multicast scope MyMulticastScope from the currently specified DHCP server.

delete mscope MyMulticastScope

delete optiondef

Deletes a defined option type from the specified DHCP server.

Syntax

delete optiondef OptCode [[vendor=]VendorName]

Parameters

OptCode
Required. Specifies the unique identifier for the option type to delete.

****vendor=VendorName
Specifies the vendor class name with which the option type is associated. If unspecified, the option type definition is deleted from the non-vendor-specific DHCP standard options class.

Examples

In the following example, this command deletes an option type with code 18 from the DHCP standard options class.

delete optiondef 18

delete optionvalue

Deletes the current value of the specified option type for the specified DHCP server.

Syntax

delete optionvalue OptCode[[vendor=]VendorClass] [[user=]UserClass]

Parameters

OptCode
Required. Specifies the unique identifier of the global server option with a value to delete.

****vendor=VendorClass
Specifies the vendor class name with which the option is associated. If the tag is not included, the global VendorName that was set by set vendorclass is assumed. If the tag is used, but no value is specified, then no vendor class is used. This parameter is available only for computers running Windows® 2000 Server.

****user=UserClass
Specifies the user class name with which the option is associated. If the tag is not included, the global UserName that was set by set userclass is assumed. If the tag is used, but no value is specified, then no user class is used. This parameter is available only for computers running Windows 2000 Server.

Examples

In the following example, this command deletes the current value of the option type with code 18.

delete optionvalue 18

delete scope

Deletes a scope from the specified DHCP server.

Syntax

delete scope ScopeAddress {DHCPNOFORCE | DHCPFULLFORCE}

Parameters

ScopeAddress
Required. Specifies the address of the scope to delete.

{DHCPNOFORCE | DHCPFULLFORCE}
Required. Indicates the force with which the scope will be deleted: DHCPNOFORCE-Deletes the scope if there are no active clients in the scope, DHCPFULLFORCE-Deletes the scope even if there are active clients in the scope.

Examples

In the following example, this command forces the deletion of the scope 10.2.2.0 from the DHCP server and ignores all warnings.

delete scope 10.2.2.0 dhcpfullforce

delete superscope

Deletes a superscope from the specified DHCP server.

Syntax

delete superscope SuperscopeName

Parameters

SuperscopeName
Required. Specifies the name of the superscope to delete.

Remarks

You can set the superscope from the scope context with the set superscope command.
The superscope name is case-sensitive.

Examples

In the following example, this command deletes the superscope named My Superscope from the specified DHCP server.

delete superscope "My Superscope"

dump

Dumps the configuration of the local DHCP server to the command prompt window when run within the netsh environment.

Syntax

dump

When run at the command prompt or in a batch file, output can be saved in a text file. Used without parameters, this command dumps the configuration of the local server to the command prompt window.

Syntax

netsh dhcp server [IPAddress] dump >[PathAndFileName]

Parameters

IPAddress
Specifies the IP address of the DHCP server for which the configuration is output.

PathAndFileName
Specifies both the location where the file is saved, and the name of the destination file to which to dump DHCP server configuration. If unspecified, the DHCP server configuration is dumped to the command prompt window.

Remarks

This command dumps the DHCP configuration as text output within the command prompt window. You can copy or redirect this output to a file to view it in a text editor. After file output is obtained, you can use the exec command to configure another DHCP server with the same configuration.
Before you perform the dump command at the source server, reconcile all scopes and fix any reported inconsistencies.
The following command dumps the current configuration for the local DHCP server (the source) to a text file named Dhcpcfg.dmp. This file can be copied to another (destination) DHCP server and used to recreate the source configuration on it. You can recreate the configuration by typing the following command:

dump > dhcpcfg.dmp
Before you use the exec command to produce a dump file at the destination server, complete the following steps:
1. Close the DHCP console at the destination server. Do not reopen the console until after you have run the exec command.
2. Delete all default option definitions and any user and vendor classes at the destination server.
These examples demonstrate how to use the delete optiondef and del class Netsh commands to delete all default option definitions and any user and vendor classes. You can run these commands at the dhcp server> prompt, from within the netsh environment.
- delete optiondef 76
- del class "Default BOOTP Class"
- del class "Microsoft Windows 98 Options"
On the destination server, the exec command is used to load and run the saved configuration:

netsh exec dhcpcfg.dmp
After you use the exec command to load the dump file, you must reconcile all scopes. Use net stop dhcpserver to stop the DHCP Server service and net start dhcpserver to restart it. Once the service is restarted, DHCP database changes take effect.

Examples

The first command, which is run within the netsh environment, dumps the configuration of the local DHCP server to the command prompt window.

The second command, which is run at the command prompt, dumps the configuration of a DHCP server with IP address 192.168.0.1 to a text file named Dhcpcfg.dmp at the location C:\Dhcp\ on the local computer.

The third command, which is run at the command prompt, dumps the configuration of a DHCP server with IP address 192.168.0.1 to a text file named Dhcpcfg.dmp on a shared network folder named \\Backup\Dhcp\.

dump

netsh dhcp server 192.168.0.1 dump > C:\Dhcp\Dhcpcfg.dmp

netsh dhcp server 192.168.0.1 dump > \\Backup\Dhcp\Dhcpcfg.dmp

export

Exports the DHCP service configuration to a file.

Syntax

export [Path]FileName {all | ScopeList}

Parameters

[Path] FileName
Required. Specifies, by name, the file where the DHCP configuration will be stored. If the path, the file name, or both contain spaces, quotation marks must be used.

{all | ScopeList}
Required. Specifies which scopes you want to export. The parameter all exports all scopes. The parameter ScopeList exports the scopes that correspond to the IP addresses you list. Each IP address in the list must be separated by spaces.

Remarks

This command works only on the local server.
While the export command runs, the DHCP service is stopped and does not respond to DHCP clients seeking new leases or lease renewals.
If the DHCP service has a large number of scopes or a large number of client address leases, this command can take a long time to run.

Examples

In the first example, this command exports the complete DHCP service configuration to the file c:\Temp\Dhcpdb.

In the second example, this command exports the DHCP configuration for scopes 10.0.0.0 and 192.168.0.0 to the file c:\Temp\Dhcpdb.

In the third example, this command exports the complete DHCP service configuration to the file c:\My Folder\Dhcp Configuration. Note that both the path and file name contain spaces, so quotation marks are used.

export c:\Temp\Dhcpdb all

export c:\Temp\Dhcpdb 10.0.0.0 192.168.0.0

export "c:\My Folder\Dhcp Configuration" all

import

Imports a DHCP service configuration from a file to the local service.

Syntax

import [Path]FileName {all | ScopeList]

Parameters

[Path] FileName
Required. Specifies, by name, the file from which the DHCP configuration will be imported. If the path, the file name, or both contain spaces, quotation marks must be used.

{all | ScopeList}
Required. Specifies which scopes you want to import. The parameter all imports all scopes represented in the file you specify. The parameter ScopeList imports the scopes that correspond to the IP addresses you list. Each IP address in the list must be separated by spaces.

Remarks

This command works only on the local server.
While the import command runs, the DHCP service is stopped and does not respond to DHCP clients seeking new leases or lease renewals.
If the DHCP service has a large number of scopes or a large number of client address leases, this command can take a long time to run.

Examples

In the first example, this command imports the complete DHCP service configuration from the file c:\Temp\Dhcpdb.

In the second example, this command imports the DHCP configuration for scopes 10.0.0.0 and 192.168.0.0 from the file c:\Temp\Dhcpdb

In the third example, this command imports the complete DHCP service configuration from the file c:\My Folder\Dhcp Configuration. Note that both the path and file name contain spaces, so quotation marks are used.

import c:\Temp\Dhcpdb all

import c:\Temp\Dhcpdb 10.0.0.0 192.168.0.0

import "c:\My Folder\Dhcp Configuration" all

initiate auth

Initiates authorization of the specified DHCP server in Active Directory.

Syntax

initiate auth

Parameters

none

mscope

Switches the command context to a DHCP multicast scope.

Syntax

mscope MscopeName

Parameters

MscopeName
Required. Specifies the name of the multicast scope to which to switch the command context.

Remarks

This command enables you to use any of the available DHCP multicast scope-level commands on the specified DHCP multicast scope. Subsequent operations will be performed on this multicast scope at the specified server.
The name of the multicast scope is case-sensitive.

Examples

In the following example, this command switches the command context to a multicast scope named My Multicast Scope.

mscope "My Multicast Scope"

restore

Restores DHCP server data, including all scopes, reservations, leases, options, configuration settings, and registry keys. The DHCP service is temporarily stopped during the restore and clients cannot contact the DHCP server to obtain IP addresses.

Syntax

restore [Path]

Parameters

[Path]
Specifies the path of the .mdb DHCP database file to be restored. If not specified, the path will default to %systemroot%\System32\Dhcp\Backup

Remarks

An error is returned when the specified database cannot be found, or the database was created with a different language version of the server.

Examples

In the following example, this command sets the restore path of the DHCP server database file to c:\MyBackUpFiles\DHCP.

restore "c:\MyBackUpFiles\DHCP”

scope

Switches the command context to a DHCP scope.

Syntax

scope ScopeIPAddress

Parameters

ScopeIPAddress
Required. Specifies the scope to which to switch the command context. Identifies the scope by network or subnet IP address.

Remarks

This command enables you to use any of the available DHCP scope-level commands on the specified DHCP scope. Subsequent operations will be performed on this scope at the specified server.

Examples

In the following example, this command switches the command context to the scope with IP address 10.0.0.0.

scope 10.0.0.0

set auditlog

Configures audit logging data for the specified DHCP server.

Syntax

set auditlog NewAuditPath Maxsize Minsize Interval

Parameters

NewAuditPath
Optional. Specifies a local folder for the DHCP server to use when storing audit log files. If a path is not specified, the location will default to %windir%\System32\Dhcp.

Maxsize
Optional. This value is a DWORD and is written to HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\DHCPServer\Parameters\DhcpLogFileMaxSize. This attribute sets the maximum size restriction (in megabytes) for the total amount of disk space available for all audit log files created and stored by the DHCP service. The default is seven.

Minsize
Optional. This value is a DWORD and is written to HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\DHCPServer\Parameters\DhcpLogMinSpaceOnDisk. This attribute sets the minimum free space (in megabytes) available on the local disk before audit logging stops. The default is 20.

Interval
Optional. This value is a DWORD and is written to HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\DHCPServer\Parameters\DhcpLogDiskSpaceCheckInterval. This attributes sets the number of times the log is written to before checking free disk space. The default is 50.

Remarks

Only the path can be configured in the DHCP GUI. The other attributes are configured through the registry.
In order for this change to take effect, you must stop and restart the DHCP service after you run this command.

Examples

In the following example, this command sets the DHCP server to store audit log files in the directory %windir%\System32\Dhcp with a maximum size of seven megabytes, minimum free space of 20 megabytes, and an interval of 120.

netsh dhcp> set auditlog interval 120

set bindings

Sets interface bindings for the server.

Syntax

set bindings Interface [Enable | Disable]

Parameters

Interface
Optional. Specifies the friendly name of the interface. The default is all local interfaces.

Mode
Optional. Specifies the binding mode.

ENABLE - Enables interface binding (default).

DISABLE - Disables the interface binding.

Remarks

Use the “Show Bindings” command to verify the value of the “Bound to Server” attribute. “TRUE” value indicates the interface binding is enabled. “FALSE” value indicates that the interface binding is disabled.

set databasebackupinterval

Sets the backup interval for the specified DHCP server.

Syntax

set databasebackupinterval NewInterval

Parameters

NewInterval
Required. Specifies the backup interval in minutes.

Examples

In the following example, this command sets the database backup interval for the specified DHCP server to 1,440 minutes (24 hours).

set databasebackupinterval 1440

set databasebackuppath

Sets the database backup path for the specified DHCP server.

Syntax

set databasebackuppath NewBackupPath

Parameters

NewBackupPath
Required. Specifies a local folder for the DHCP server to use when storing audit log files. A valid folder path is required, and the folder must be local to the DHCP server where the path is defined.

Examples

In the following example, this command sets the database backup path to c:\windows\dhcp\backup.

set databasebackuppath c:\windows\dhcp\backup

set databasecleanupinterval

Sets the database cleanup interval of the specified DHCP server.

Syntax

set databasecleanupinterval NewInterval

Parameters

NewInterval
Required. Specifies the database cleanup interval, in minutes.

Examples

In the following example, this command sets the database cleanup interval to 10,080 minutes (every seven days).

set databasecleanupinterval 10080

set databaseloggingflag

Sets or resets the database logging flag for the specified DHCP server. Used without parameters, this command resets the database logging flag.

Syntax

set databaseloggingflag [{0 | 1}]

Parameters

{0 | 1}
Indicates the database logging flag setting: 0-Resets the flag (default), 1-Sets the flag.

Examples

In the following example, this command resets the database logging flag for the currently specified DHCP server.

set databaseloggingflag 0

set databasename

Sets the name of the DHCP server database file for the specified DHCP server.

Syntax

set databasename NewFileName

Parameters

NewFileName
Required. Specifies a new name for the DHCP server database file.

Remarks

In order for this change to take effect, you must stop and restart the DHCP Server service.

Examples

In the following example, this command sets the DHCP server database file name to newdatabase.mdb.

set databasename newdatabase.mdb

set databasepath

Sets the path of the DHCP server database file for the specified DHCP server.

Syntax

set databasepath NewPath

Parameters

NewPath
Required. Specifies the path of the DHCP database file.

Remarks

In order for this change to take effect, you must stop and restart the DHCP Server service.

Examples

In the following example, this command sets the path of the DHCP server database file to c:\windows\dhcp.

set databasepath c:\windows\dhcp

set databaserestoreflag

Sets or resets the database restore flag for the specified DHCP server. Used without parameters, this command resets the database restore flag.

Syntax

set databaserestoreflag [{0 | 1}]

Parameters

{0 | 1}
Indicates the setting of the database restore flag: 0-Resets the flag (default), 1-Sets the flag.

Examples

In the following example, this command sets the database restore flag for the currently specified DHCP server.

set databaserestoreflag 1

set detectconflictretry

Sets the number of conflict detection attempts for the specified DHCP server.

Syntax

set detectconflictretry RetryNumber

Parameters

RetryNumber
Required. Specifies the number of conflict detection attempts that the DHCP server will make before it leases a scope IP address to a client.

Remarks

The maximum value for RetryNumber is five. All values greater than five will default down to five.

Examples

In the following example, this command sets the DHCP server to make four attempts to detect if a there is a conflict for a scope IP address before the DHCP server uses this scope IP address in a new address lease.

set detectconflictretry 4

set dnsconfig

Sets the Domain Name System (DNS) dynamic update configuration for the specified DHCP server.

Syntax

set dnsconfig [Enable=]{0 | 1} [[Update=]{0 | 1}] [[Lookup=]{0 | 1}] [[NonDyn=]{0 | 1}]

Parameters

[Enable=]{0 | 1}
Required. Indicates whether to enable or disable the dynamic updates of DNS client information: 0-Disables dynamic updates of DNS client information, 1-Enables dynamic updates of DNS client information.

[Update=]{0 | 1}
Indicates the type of update lookups: 0-Updates according to client request, 1-Updates forward and reverse name lookups.

[Lookup=]{0 | 1}
Indicates whether to enable or disable forward lookups for clients when leases expire: 0-Disables forward lookups, 1-Enables forward lookups.

[NonDyn=]{0 | 1}
Indicates whether to update DNS information for clients that do not support dynamic updates: 0-Disables updates for clients that do not support dynamic updates, 1-Enables these updates.

Remarks

This command is only supported for DHCP servers running Windows 2000 Server and members of the Windows Server 2003 family.
The configured Preferred DNS server, in the TCP/IP properties of the DHCP server, will be updated with DHCP client records when dynamic updates are enabled. If the Preferred DNS server is not available on the network, the Alternate DNS server will be updated.

Examples

In the following example, this command enables the dynamic update of DNS information by the DHCP server and configures updates to always be made for both forward and reverse lookups. This example also disables the option to perform forward lookups when leases expire and enables updates for non-dynamic clients.

set dnsconfig 1 1 0 1

set dnscredentials

Sets DNS dynamic update credentials for the specified DHCP server.

Syntax

set dnscredentials UserName Domain Password

Parameters

UserName
Required. The user name associated with a valid domain account.

Domain
Required. The domain in which the user account is located.

Password
Required. The password for the user account.

Examples

In the first example, this command sets the DNS dynamic update credentials to the values specified.

In the second example, this command sets the value of UserName to User1 and the value of Domain to Domain1, but the password is not specified. Instead, an asterisk (*) is used. When an asterisk (*) is used in place of a valid password, the user is prompted for a password. Without the correct password for the specified UserName, the credentials cannot be changed.

set dnscredentials User1 Domain1 Password1

set dnscredentials User1 Domain1 *

set napstate

Turns NAP functionality on or off.

Syntax

set napstateoption [On | Off]

set napdeffail

Sets the NAP default failure state.

Syntax

set napdeffailstate { fullaccess | drop | quarantine }

set optionvalue

Sets a DHCP server option value that will be applied for all scopes defined at the specified DHCP server.

Syntax

set optionvalue OptCode {BYTE | WORD | DWORD | STRING | IPADDRESS} [[user=]UserName] [[vendor=]VendorName] [OptionValue]

Parameters

OptCode
Required. Specifies the unique identifier for the option type with the value to set.

{BYTE | WORD | DWORD | STRING | IPADDRESS}
Required. Specifies the data type for the option type with the value to set.

[user=]UserName
Sets the applicable user class name to which this command will apply. If unspecified, the default user class is assumed.

[vendor=]VendorName
Sets the applicable vendor class name to which this command will apply. If unspecified, the DHCP standard options class is assumed.

[OptionValue]
Specifies the new server default value for the option type identified by OptCode. The value must be of the associated data type.

Remarks

Vendor and user classes are supported only for DHCP servers running Windows 2000 Server.
To modify the current defaults for an unspecified class, use either the set userclass or set vendorclass commands.

Examples

In the first example, this command sets the value of option code 003 to list two router IP addresses, 10.1.1.1 and 10.1.1.2.

In the second example, this command further qualifies the first example and sets the specified value to apply only for those scope clients that identify themselves as members of the vendor class Vendor1. In order for this example to work, this class must already be defined at the server, with the specified option type defined for its use.

set optionvalue 003 IPADDRESS 10.1.1.1 10.1.1.2

set optionvalue 003 IPADDRESS vendor=Vendor1 10.1.1.1 10.1.1.2

set server

Changes the Netsh command-line context to the specified server. Used without parameters, the local server is assumed.

Syntax

set server[{ServerIP | **\\**ServerDNS}]

Parameters

**{ServerIP | **\\ServerDNS}
Specifies the IP address or the DNS name of the specified DHCP server.

Remarks

When this command is used, and the Netsh command-line context is changed to another server, all subsequent command operations are performed on the specified server. To perform command operations on another server, this command must be run again, with the IP address or DNS name of the new server provided as the parameter.

Examples

In the following example, this command switches the DHCP server command-line context to the server at IP address 10.1.1.1

set server 10.1.1.1

set userclass

Sets the name for the current user class. Used without parameters, the current user class is reset to the default user class

Syntax

set userclass [UserClass]

Parameters

UserClass
Specifies the name of the user class for the currently specified DHCP server.

Remarks

This command is available only for use with DHCP servers running Windows 2000 Server.

Examples

In the first example, this command sets the user class name to MyUserClass.

In the second example, this command resets the current user class to the default user class.

set userclass MyUserClass

set userclass

set vendorclass

Sets the name for the current vendor class. Used without parameters, the current vendor class is reset to the default class, DHCP standard options.

Syntax

set vendorclass [VendorClass]

Parameters

VendorClass
Specifies the name of the vendor class for the current server.

Remarks

This command is available only for use with DHCP servers running Windows 2000 Server.

Examples

In the first example, this command sets the vendor class name to MyVendorClass.

In the second example, this command resets the current vendor class to the default class, DHCP standard options.

set vendorclass MyVendorClass

set vendorclass

show all

Displays all status and configuration information for the specified DHCP server.

Syntax

show all

Parameters

none

Remarks

This command lists all current server status and configuration details, including the stored management information base (MIB) information, for the currently specified DHCP server.

show auditlog

Displays all audit log information for the specified DHCP server.

Syntax

show auditlog

Parameters

none

show bindings

Displays bindings information for the specified DHCP server.

Syntax

show bindings

Parameters

none

Remarks

This command displays bindings information for the current DHCP server, indicating which active network connections that are configured with static IP addresses are enabled or disabled for use in servicing DHCP clients on your network.
The DHCP service automatically disables network connections that obtain their IP address configuration dynamically from service bindings. This happens by default.

show class

Enumerates and displays all class information for the specified DHCP server. This includes both user and vendor class information.

Syntax

show class

Parameters

none

show detectconflictretry

Displays the configured number of conflict detection attempts for the specified DHCP server.

Syntax

show detectconflictretry

Parameters

none

Remarks

This command displays the current number of ping retries that are used to attempt the detection of address conflicts for the scope IP addresses that are distributed by the server.

show dnsconfig

Displays the DNS dynamic update configuration for the specified DHCP server.

Syntax

show dnsconfig

Parameters

none

Remarks

If DNS configuration has not been enabled or set, you can use the DNS console or the set dnsconfig command to configure these settings.

show dnscredentials

Displays the current DNS dynamic update credentials.

Syntax

show dnscredentials

Parameters

none

show mibinfo

Displays management information base (MIB) information for the specified DHCP server.

Syntax

show mibinfo

Parameters

none

show mscope

Displays all information about multicast scopes for the specified DHCP server.

Syntax

show mscope

Parameters

none

show napstate

Displays whether NAP functionality is turned on or off.

Syntax

show napstate

show napdeffail

Displays the NAP default failure state.

Syntax

show napdeffail

show optiondef

Displays all defined and available options types for use at the specified DHCP server. Used without parameters, all options are displayed.

Syntax

show optiondef [**vendor=**VendorName]

Parameters

****vendor=VendorName
Indicates which defined and available option types to display. If unspecified, the default for VendorName is the default vendor class that is currently set for the DHCP server.

Remarks

The default vendor class can be reset with the set vendorclass command.
VendorName is applicable only for DHCP servers running Windows 2000 Server.

Examples

In the first example, this command displays all defined option types for the current vendor class.

In the second example, this command displays the defined option types that are available for use with the specified class Vendor1.

show optiondef

show optiondef vendor=Vendor1

show optionvalue

Displays all of the available option values that are currently set for the specified DHCP server. Used without parameters, all option values are displayed, including those that are used for both user and vendor classes.

Syntax

show optionvalue[{**user=**UserName | **vendor=**VendorName}]

Parameters

****user=UserName
Specifies the default values that are set for the option types that are available for use with the currently set user class.

****vendor=VendorName
Specifies the default values that are set for the option types that are available for use with the currently set vendor class.

Remarks

**User=**UserName and **vendor=**VendorName are only available for use with DHCP servers running Windows 2000 Server.
If you provide values for UserName or VendorName, the respective tags (user= or vendor=) are required. If the tags are not included, the default that is assumed is the current user class, previously set with the set userclass command.

Examples

In the following example, this command displays all of the available option types that have values set at the currently specified DHCP server.

show optionvalue

show scope

Displays information about the scopes for the specified DHCP server.

Syntax

show scope

Parameters

none

show superscope

Displays information about the superscopes for the specified DHCP server.

Syntax

show superscope

Parameters

none

show server

Displays information about the specified DHCP server, including the fully qualified domain name and IP address of the server.

Syntax

show server

Parameters

none

show dbproperties

Displays information about server database configuration for the specified DHCP server.

Syntax

show dbproperties

Parameters

none

Remarks

This command displays the following database configuration information:
- DatabaseName
- DatabasePath
- DatabaseBackupPath
- DatabaseBackupInterval
- DatabaseLoggingFlag
- DatabaseRestoreFlag
- DatabaseCleanupInterval

show serverstatus

Displays status information for the specified DHCP server.

Syntax

show serverstatus

Parameters

none

Remarks

This is an example of the type of status information that this command displays:

Server Attrib - Server Servicing Clients :TRUE

Server Attrib - Dynamic BootP Support Enabled :TRUE

Server Attrib - DHCP server Part Of DS :TRUE

Server Attrib - DHCP server Bindings Aware :TRUE

Server Attrib - Administrative Rights :TRUE

show userclass

Displays the current user class setting at the specified DHCP server.

Syntax

show userclass

Parameters

none

Remarks

This is an example of the type of setting information that this command displays:

Current Class Name set for the Server dhcpsrv1.example.microsoft.com is None.

show vendorclass

Displays the current vendor class setting at the specified DHCP server.

Syntax

show vendorclass

Parameters

none

Remarks

This is an example of the type of setting information that this command displays:

Current Vendor Name set for the Server dhcpsrv1.example.microsoft.com is None.

show version

Displays current version information for the specified DHCP server.

Syntax

show version

Parameters

none

Remarks

This is an example of the type of version information that this command displays:

The version of the DHCP server 192.168.0.100 is 5.6.

Netsh DHCP server V4

The following commands are available at the dhcp server v4> prompt, which is rooted within the netsh environment.

To view the command syntax, click a command:

add optiondef
add scope
add class
delete optiondef
delete optionvalue
delete scope
delete class
set bindings
set optionvalue
set userclass
set vendorclass
show bindings
show mibinfo
show optiondef
show optionvalue
show scope
show userclass
show vendorclass
show class
export
import

Netsh DHCP server V6 in Windows Server 2008

The following commands can run from the dhcp server v6> prompt, which is rooted within the netsh environment.

To view the command syntax, click a command:

add optiondef
add scope
add class
delete optiondef
delete optionvalue
delete scope
delete class
set bindings
set optionvalue
set unicastflag
set rapidcommitflag
set preferredlifetime
set validlifetime
set t1
set t2
set userclass
set vendorclass
show bindings
show mibinfo
show optiondef
show optionvalue
show rapidcommitflag
show unicastflag
show preferredlifetime
show validlifetime
show t1
show t2
show scope
show userclass
show vendorclass
show class
export
import

set unicastflag

Sets the global unicast flag for the server.

Syntax

set unicastflag [ on | off ]

set rapidcommitflag

Sets the global unicast flag for the server.

Syntax

set rapidcommitflag [ on | off ]

set preferredlifetime

Sets the preferred lifetime of an issued lease on the DHCP server.

Syntax

set preferredlifetime [lifetime=seconds]

Parameters

Lifetime
The preferred lifetime in seconds.

Example

The following command sets the preferred lifetime on the DHCP server to 1 hour:
set preferredlifetime 3600

set validlifetime

Sets the valid lifetime of a lease on the DHCP server.

Syntax

set validlifetime [lifetime=seconds]

Parameters

Lifetime
The preferred lifetime in seconds.

Example

The following command sets the valid lifetime on the DHCP server to 1 hour:
set validlifetime 3600

set t1

Sets the value of T1 of an issued lease on the DHCP server.

Syntax

set t1 [lifetime=seconds]

Parameters

Lifetime
The preferred lifetime in seconds.

Example

The following command sets T1 on the DHCP server to 1 hour:
set t1 3600

set t2

Sets the value of T2 of an issued lease on the DHCP server.

Syntax

set t2 [lifetime=seconds]

Parameters

Lifetime
The preferred lifetime in seconds.

Example

The following command sets T2 on the DHCP server to 1 hour:
set t2 3600

show rapidcommitflag

Displays the rapidcommitflag.

Syntax

show rapidcommitflag

Parameters

none

show unicastflag

Displays the unicastflag.

Syntax

show unicastflag

Parameters

none

show preferredlifetime

Displays the preferred lifetime of an issued lease on the DHCP server.

Syntax

show preferredlifetime

Parameters

none

show validlifetime

Displays the valid lifetime of a lease on the DHCP server.

Syntax

show validlifetime

Parameters

none

show t1

Displays the value of T1 of an issued lease on the DHCP server.

Syntax

show t1

Parameters

none

show t2

Displays the value of T2 of an issued lease on the DHCP server.

Syntax

show t2

Parameters

none

Netsh DHCP server V6 in Windows Server 2008 R2

The following commands can run from the dhcp server v6> prompt, which is rooted within the netsh environment.

Unless otherwise noted in this reference, Netsh commands in Windows Server 2008 R2 provide the same functionality as the Netsh commands in Windows Server 2008.

To view the command syntax, click a command:

add optiondef
add scope
add class
delete optiondef
delete optionvalue
delete scope
delete class
set bindings
set optionvalue
set unicastflag
set rapidcommitflag
set preferredlifetime
set validlifetime
set t1
set t2
set userclass
set vendorclass
show bindings
show mibinfo
show optiondef
show optionvalue
show rapidcommitflag
show unicastflag
show preferredlifetime
show validlifetime
show t1
show t2
show scope
show userclass
show vendorclass
show class
export
import

set nameprotection

Enables or disables the use of the DHCP ID Resource Record for registeringAAAA records in the DNS Server.

Syntax

set nameprotection