DHCP Server Cmdlets in Windows PowerShell

Updated: November 1, 2016

Applies To: Windows 10, Windows PowerShell 5.0, Windows Server 2016

Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.

Dynamic Host Configuration Protocol (DHCP) server service

This reference provides cmdlet descriptions and syntax for all Dynamic Host Configuration Protocol (DHCP) server service-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.

Also see DHCP Classes (http://go.microsoft.com/FWLink/p/?LinkId=260590).

 

cmdlet Description

Add-DhcpServerInDC

Adds the computer that runs the DHCP server service to the list of authorized DHCP server services in Active Directory.

Add-DhcpServerSecurityGroup

Adds security groups to a DHCP server.

Add-DhcpServerv4Class

Adds an IPv4 vendor or user class to the DHCP server service.

Add-DhcpServerv4ExclusionRange

Adds a range of excluded IP addresses for an IPv4 scope.

Add-DhcpServerv4Failover

Adds an IPv4 failover relationship on the DHCP server service.

Add-DhcpServerv4FailoverScope

Adds one or more specified scopes to the failover relationship.

Add-DhcpServerv4Filter

Adds a MAC address filter to the DHCP server service.

Add-DhcpServerv4Lease

Adds a new IPv4 address lease in the DHCP server service.

Add-DhcpServerv4MulticastExclusionRange

Adds a range of addresses to exclude from a multicast scope.

Add-DhcpServerv4MulticastScope

Adds a multicast scope on the DHCP server.

Add-DhcpServerv4OptionDefinition

Adds a DHCPv4 option definition on the DHCP server service.

Add-DhcpServerv4Policy

Adds a new policy either at the server level or at the scope level.

Add-DhcpServerv4PolicyIPRange

Adds an IP range to an existing policy at the scope level.

Add-DhcpServerv4Reservation

Reserves an IPv4 address in the scope for a client.

Add-DhcpServerv4Scope

Adds an IPv4 scope on the DHCP server service.

Add-DhcpServerv4Superscope

Adds scopes to a superscope.

Add-DhcpServerv6Class

Adds an IPv6 vendor or user class to the DHCP server service.

Add-DhcpServerv6ExclusionRange

Sets the range of IPv6 addresses to exclude from an IPv6 scope.

Add-DhcpServerv6Lease

Adds an IPv6 address lease to the DHCP server service.

Add-DhcpServerv6OptionDefinition

Adds a DHCPv6 option definition to a DHCP server service.

Add-DhcpServerv6Reservation

Adds an IPv6 Reservation to an IPv6 prefix or scope.

Add-DhcpServerv6Scope

Adds an IPv6 scope to the DHCP server service with the specified parameters.

Backup-DhcpServer

Backs up the DHCP database of DHCP server service.

Export-DhcpServer

Exports the DHCP server service configuration and lease data.

Get-DhcpServerAuditLog

Gets the configuration parameters related to the audit log of the DHCP server service.

Get-DhcpServerDatabase

Gets the configuration parameters related to the database of the DHCP server service.

Get-DhcpServerDnsCredential

Gets an account that the DHCP Server service uses to register or deregister client records on a DNS server.

Get-DhcpServerInDC

Retrieves the list of authorized computers that run the DHCP server service from Active Directory.

Get-DhcpServerSetting

Gets the configuration parameters of the database of the DHCP server service.

Get-DhcpServerv4Binding

Gets the IPv4 interfaces on the computer to which the DHCP server service is bound.

Get-DhcpServerv4Class

Retrieves an IPv4 vendor or user class from the DHCP server service.

Get-DhcpServerv4DnsSetting

Gets the DNS settings configured on the DHCP server service for a specific scope, reservation, or server level.

Get-DhcpServerv4ExclusionRange

Returns the IPv4 address ranges excluded from the specified scope IDs.

Get-DhcpServerv4Failover

Gets the failover relationships configured on the DHCP server service for the specific failover relationship name.

Get-DhcpServerv4Filter

Gets MAC addresses from the allow list or the deny list on the DHCP server service.

Get-DhcpServerv4FilterList

Gets the enabled state of the allow filter list and deny filter list set on the DHCP server service.

Get-DhcpServerv4FreeIPAddress

Gets free IPv4 addresses from a specified scope.

Get-DhcpServerv4Lease

Gets one or more lease records from the DHCP server service.

Get-DhcpServerv4MulticastExclusionRange

Retrieves the exclusion range for a specified multicast scope.

Get-DhcpServerv4MulticastLease

Retrieves multicast leases for a specified scope name.

Get-DhcpServerv4MulticastScope

Gets multicast scope objects.

Get-DhcpServerv4MulticastScopeStatistics

Gets multicast scope statistics.

Get-DhcpServerv4OptionDefinition

Gets the DHCPv4 option definition for the specified option IDs.

Get-DhcpServerv4OptionValue

Returns the IPv4 option values for IPv4 options at the server, scope, or reservation level.

Get-DhcpServerv4Policy

Gets policies at the server level or the scope level.

Get-DhcpServerv4PolicyIPRange

Gets IP address ranges from a policy in the specified scope.

Get-DhcpServerv4Reservation

Gets IPv4 reservations for IP addresses or client IDs.

Get-DhcpServerv4Scope

Returns the IPv4 scope configuration of the specified scopes.

Get-DhcpServerv4ScopeStatistics

Gets the IPv4 scope statistics corresponding to the IPv4 scope IDs specified for a DHCP server service.

Get-DhcpServerv4Statistics

Gets DHCP server service statistics for IPv4.

Get-DhcpServerv4Superscope

Gets the configuration for the specified superscope.

Get-DhcpServerv4SuperscopeStatistics

Returns statistics for superscopes.

Get-DhcpServerv6Binding

Returns the IPv6 interfaces to which the DHCP server service is bound.

Get-DhcpServerv6Class

Gets the IPv6 vendor or user class from the DHCP server service.

Get-DhcpServerv6DnsSetting

Gets the DNS settings configured on the DHCP server service for a specific scope, reservation, or server-wide.

Get-DhcpServerv6ExclusionRange

Gets the IPv6 address ranges excluded from the specified IPv6 subnet prefix.

Get-DhcpServerv6FreeIPAddress

Gets free IPv6 addresses from a scope.

Get-DhcpServerv6Lease

Gets IPv6 lease records from the DHCP server service.

Get-DhcpServerv6OptionDefinition

Gets the option definition for the option identified by the option ID.

Get-DhcpServerv6OptionValue

Returns the IPv6 option values for one or more IPv6 options either for a specific reserved IP, scope or, server level.

Get-DhcpServerv6Reservation

Returns the reserved IPv6 addresses on the DHCP server service.

Get-DhcpServerv6Scope

Gets the scope information for the specified IPv6 prefixes on the DHCP server service.

Get-DhcpServerv6ScopeStatistics

Gets the IPv6 prefix statistics for an IPv6 prefix specified for a DHCP server service.

Get-DhcpServerv6StatelessStatistics

Gets IPv6 subnet prefixes which have stateless clients and the number of addresses in use in each subnet.

Get-DhcpServerv6StatelessStore

Gets the properties of IPv6 stateless store for an IPv6 subnet.

Get-DhcpServerv6Statistics

Gets the DHCP server service statistics for IPv6.

Get-DhcpServerVersion

Gets the version of the DHCP server service.

Import-DhcpServer

Imports the DHCP server service configuration, and optionally lease data, from a file.

Invoke-DhcpServerv4FailoverReplication

Replicates scope configuration between failover partner DHCP server services.

Remove-DhcpServerDnsCredential

Removes the credential that the DHCP Server service uses to register or deregister client records on a DNS server.

Remove-DhcpServerInDC

Deletes the specified DHCP server service from the list of authorized DHCP server services in Active Directory.

Remove-DhcpServerv4Class

Deletes the IPv4 vendor class or user class from a DHCP server service.

Remove-DhcpServerv4ExclusionRange

Deletes a range of IPv4 addresses that were previously excluded from an IPv4 scope.

Remove-DhcpServerv4Failover

Removes failover relationships.

Remove-DhcpServerv4FailoverScope

Removes the specified scopes from the failover relationship.

Remove-DhcpServerv4Filter

Deletes a MAC address or MAC address pattern from the allow list or the deny list of the DHCP server service.

Remove-DhcpServerv4Lease

Deletes IPv4 address lease records from the DHCP server service.

Remove-DhcpServerv4MulticastExclusionRange

Removes a range of addresses previously excluded from a multicast scope.

Remove-DhcpServerv4MulticastLease

Removes multicast scope leases for a multicast scope or IP address.

Remove-DhcpServerv4MulticastScope

Removes multicast scopes.

Remove-DhcpServerv4OptionDefinition

Deletes IPv4 option definitions from a DHCP server service.

Remove-DhcpServerv4OptionValue

Deletes one or more IPv4 option values at the server, scope or reservation level, either for the standard IPv4 options or for the specified vendor or user class.

Remove-DhcpServerv4Policy

Deletes IPv4 policies at the server level or the scope level.

Remove-DhcpServerv4PolicyIPRange

Deletes an IP range from an existing policy at the scope level.

Remove-DhcpServerv4Reservation

Deletes the IPv4 reservation from the specified scope.

Remove-DhcpServerv4Scope

Deletes the specified IPv4 scopes from the DHCP server service.

Remove-DhcpServerv4Superscope

Removes scopes from a superscope.

Remove-DhcpServerv6Class

Deletes the specified IPv6 vendor class or user class from a DHCP server service.

Remove-DhcpServerv6ExclusionRange

Deletes a range of IPv6 addresses previously excluded from an IPv6 scope.

Remove-DhcpServerv6Lease

Deletes IPv6 lease records from the DHCP server service.

Remove-DhcpServerv6OptionDefinition

Deletes IPv6 option definitions from the DHCP server service.

Remove-DhcpServerv6OptionValue

Deletes DHCPv6 option values set at the reservation level, scope level, or server level, for the standard IPv6 options or for a vendor class.

Remove-DhcpServerv6Reservation

Deletes IPv6 reservations from the specified scope.

Remove-DhcpServerv6Scope

Deletes the IPv6 scopes from the DHCP server service corresponding to the specified prefixes.

Rename-DhcpServerv4Superscope

Renames a superscope.

Repair-DhcpServerv4IPRecord

Reconciles inconsistent lease records in the DHCP database.

Restore-DhcpServer

Restores the database of the DHCP server service from the specified location.

Set-DhcpServerAuditLog

Sets the DHCP server service audit log configuration on the DHCP server service that runs on the computer.

Set-DhcpServerDatabase

Modifies one or more configuration parameters of the database of the DHCP server service.

Set-DhcpServerDnsCredential

Sets credentials that the DHCP Server service uses to register or deregister client records on a DNS server.

Set-DhcpServerSetting

Sets server level configuration parameters for the DHCP server service.

Set-DhcpServerv4Binding

Sets the binding state of an IPv4 interface for the DHCP server service that runs on a computer.

Set-DhcpServerv4Class

Modifies an IPv4 vendor class or user class on the DHCP server service with the specified parameters.

Set-DhcpServerv4DnsSetting

Configures how the DHCP server service updates the DNS server with the client-related information.

Set-DhcpServerv4Failover

Modifies the properties of an existing failover relationship.

Set-DhcpServerv4FilterList

Sets the enabled state for the allow and the deny MAC address filter lists on the DHCP server service.

Set-DhcpServerv4MulticastScope

Modifies the properties of a multicast scope.

Set-DhcpServerv4OptionDefinition

Modifies the properties of an IPv4 option definition.

Set-DhcpServerv4OptionValue

Sets an IPv4 option value at the server, scope, or reservation level.

Set-DhcpServerv4Policy

Sets the properties of a policy at the server level or at the specified scope level.

Set-DhcpServerv4Reservation

Modifies the properties of an IPv4 reservation.

Set-DhcpServerv4Scope

Sets the properties of an existing IPv4 scope on the DHCP server service.

Set-DhcpServerv6Binding

Sets the binding state for an IPv6 interface of the DHCP server service.

Set-DhcpServerv6Class

Modifies the properties of an IPv6 vendor or user class on the DHCP server service.

Set-DhcpServerv6DnsSetting

Configures how the DHCP server service updates the DNS server with the client-related information.

Set-DhcpServerv6OptionDefinition

Modifies the properties of a DHCPv6 option definition.

Set-DhcpServerv6OptionValue

Sets an IPv6 option value at the server, scope, or reservation level.

Set-DhcpServerv6Reservation

Modifies the properties of the specified IPv6 reservation.

Set-DhcpServerv6Scope

Modifies the properties of the IPv6 scope on the DHCP server service.

Set-DhcpServerv6StatelessStore

Sets properties of IPv6 stateless store for an IPv6 prefix.

noteNote
To list all the cmdlets that are available, use the Get-Command –Module DhcpServer cmdlet.

For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets:

Get-Help <cmdlet name> -Detailed
Get-Help <cmdlet name> -Examples
Get-Help <cmdlet name> -Full

More Information

For more information about the cmdlets, see the following:

Community Additions

ADD
Show: