DHCP Server Cmdlets in Windows PowerShell
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 (https://go.microsoft.com/FWLink/p/?LinkId=260590).
cmdlet | Description |
---|---|
Adds the computer running the DHCP server service to the list of authorized Dynamic Host Configuration Protocol (DHCP) server services in Active Directory (AD). |
|
Adds an IPv4 vendor or user class to the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Adds a range of excluded IP addresses for an IPv4 scope. |
|
Adds a new IPv4 failover relationship on the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Adds one or more specified scopes to the failover relationship. |
|
Adds a MAC address filter to the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Adds a new IPv4 address lease in the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Adds a new DHCPv4 option definition on the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Adds a new policy either at the server level or at the scope level. |
|
Adds an IP range to an existing policy at the scope level. |
|
Reserves the specified IPv4 address in the scope for a client. |
|
Adds an IPv4 scope on the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Adds one or more specified scopes to a superscope. |
|
Adds an IPv6 vendor or user class to the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Sets the range of IPv6 addresses to exclude from an IPv6 scope. |
|
Adds a new IPv6 address lease to the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Adds a DHCPv6 option definition to a Dynamic Host Configuration Protocol (DHCP) server service running on the local or a remote computer. |
|
Adds an IPv6 Reservation to an IPv6 prefix or scope. |
|
Adds an IPv6 scope to the Dynamic Host Configuration Protocol (DHCP) server service with the specified parameters. |
|
Backs up the Dynamic Host Configuration Protocol (DHCP) database of DHCP server service to the specified location. |
|
Exports the Dynamic Host Configuration Protocol (DHCP) server service configuration, and optionally lease data, to the specified file. |
|
Gets the configuration parameters related to the audit log of the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Gets the configuration parameters related to the database of the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Retrieves the list of authorized computers running the Dynamic Host Configuration Protocol (DHCP) server service from Active Directory (AD). |
|
Gets the configuration parameters of the database of the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Gets all of the IPv4 interfaces on the computer to which the Dynamic Host Configuration Protocol (DHCP) server service is bound. |
|
Retrieves an IPv4 vendor or user class from the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Gets the DNS settings configured on the Dynamic Host Configuration Protocol (DHCP) server service for a specific scope, reservation, or server level. |
|
Returns the IPv4 address ranges excluded from the specified scope identifiers (IDs). |
|
Gets the failover relationships configured on the Dynamic Host Configuration Protocol (DHCP) server service for the specific failover relationship name. |
|
Gets the list of all MAC addresses from the allow list or the deny list on the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Gets the enabled state of the allow filter list and deny filter list set on the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Gets one or more free, or unassigned, IP Addresses from the specified scope. |
|
Gets one or more lease records from the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Gets the DHCPv4 option definition for the specified option identifiers (IDs). |
|
Returns the IPv4 option Values for one or more IPv4 options at the server, scope or reservation level. |
|
Gets one or more policies at the server level or the scope level. |
|
Gets one or more IP ranges from a policy in the specified scope. |
|
Gets one or more IPv4 reservations for the specified IP addresses or client identifiers (IDs). |
|
Returns the IPv4 scope configuration of the specified scopes. |
|
Gets the IPv4 scope statistics corresponding to the IPv4 scope identifiers (IDs) specified for a Dynamic Host Configuration Protocol (DHCP) server service. |
|
Gets Dynamic Host Configuration Protocol (DHCP) server service statistics for IPv4. |
|
Gets Dynamic Host Configuration Protocol (DHCP) server service statistics for IPv4. |
|
Returns the IPv6 interfaces to which the Dynamic Host Configuration Protocol (DHCP) server service is bound. |
|
Gets the IPv6 vendor or user class from the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Gets the DNS settings configured on the Dynamic Host Configuration Protocol (DHCP) server service for a specific scope, reservation, or server-wide. |
|
Gets the IPv6 address ranges excluded from the specified IPv6 subnet prefix. |
|
Gets one or more free, or unassigned, IPv6 addresses from the specified scope. |
|
Gets one or more IPv6 lease records from the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Gets the option definition for the option identified by the option identifier (ID). |
|
Returns the IPv6 option values for one or more IPv6 options either for a specific reserved IP, scope or, server level. |
|
Returns the reserved IPv6 addresses on the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Gets the scope information for the specified IPv6 prefixes on the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Gets the IPv6 prefix statistics that correspond to the IPv6 prefix specified for a Dynamic Host Configuration Protocol (DHCP) server service. |
|
Gets a list of IPv6 subnet prefixes which have stateless clients and the number of addresses in use in each of the subnets. |
|
Gets the properties of IPv6 stateless store for the specified IPv6 subnet. |
|
Gets the Dynamic Host Configuration Protocol (DHCP) server service statistics for IPv6. |
|
Gets the version of the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Imports the Dynamic Host Configuration Protocol (DHCP) server service configuration, and optionally lease data, from the specified file. |
|
Replicates scope configuration between failover partner Dynamic Host Configuration Protocol (DHCP) server services. |
|
Deletes the specified Dynamic Host Configuration Protocol (DHCP) server service from the list of authorized server services in Active Directory (AD). |
|
Deletes the IPv4 vendor class or user class from a Dynamic Host Configuration Protocol (DHCP) server service. |
|
Deletes a range of IPv4 addresses that were previously excluded from an IPv4 scope. |
|
Removes one or more specified failover relationships. |
|
Removes the specified scopes from the failover relationship. |
|
Deletes the specified MAC address or MAC address pattern from the allow list or the deny list of the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Deletes the specified IPv4 address lease record from the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Delete one or more IPv4 option definitions from a Dynamic Host Configuration Protocol (DHCP) server service. |
|
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. |
|
Deletes one or more specified IPv4 policies either at the server level or the specified scope level. |
|
Deletes an IP range from an existing policy at the scope level. |
|
Deletes the IPv4 Reservation from the specified scope. |
|
Deletes the specified IPv4 scopes from the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Removes one or more specified scopes from a superscope. |
|
Deletes the specified IPv6 vendor class or user class from a Dynamic Host Configuration Protocol (DHCP) server service. |
|
Deletes a range of IPv6 addresses previously excluded from an IPv6 scope. |
|
Deletes one or more IPv6 lease records from the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Deletes one or more IPv6 option definitions from the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Deletes one or more DHCPv6 option values set at the reservation level, scope level, or server level, either for the standard IPv6 options or for a specified vendor class. |
|
Deletes one or more IPv6 reservations from the specified scope. |
|
Deletes the IPv6 Scopes from the Dynamic Host Configuration Protocol (DHCP) server service corresponding to the specified prefixes. |
|
Restores the database of the Dynamic Host Configuration Protocol (DHCP) server service from the specified location. |
|
Sets the Dynamic Host Configuration Protocol (DHCP) server service audit log configuration on the DHCP server service running on the computer. |
|
Modifies one or more configuration parameters of the database of the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Sets one or more server level configuration parameters for the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Sets the binding state of specified IPv4 interface for the Dynamic Host Configuration Protocol (DHCP) server service running on the specified computer. |
|
Modifies an IPv4 vendor class or user class on the Dynamic Host Configuration Protocol (DHCP) server service with the specified parameters. |
|
Configures how the Dynamic Host Configuration Protocol (DHCP) server service updates the DNS server with the client-related information. |
|
Modifies the properties of an existing failover relationship. |
|
Sets the enabled state for the allow, the deny, or both the allow and deny MAC address filter lists on the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Modifies the properties of an existing IPv4 option definition. |
|
Sets an IPv4 option value at the server, scope, or reservation level. |
|
Sets the properties of an existing policy either at the server level or at the specified scope level. |
|
Modifies the properties of an IPv4 reservation. |
|
Sets the properties of an existing IPv4 scope on the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Sets the binding state for the specified IPv6 interface of the Dynamic Host Configuration Protocol (DHCP) server service on the computer. |
|
Modifies the properties of an IPv6 vendor or user class on the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Configures how the Dynamic Host Configuration Protocol (DHCP) server service updates the DNS server with the client-related information |
|
Modifies the properties of an existing DHCPv6 option definition. |
|
Sets an IPv6 option value at the server, scope, or reservation level. |
|
Modifies the properties of the specified IPv6 reservation. |
|
Modifies the properties of the IPv6 scope on the Dynamic Host Configuration Protocol (DHCP) server service. |
|
Sets the properties of IPv6 stateless store for the specified IPv6 prefix. |
Hinweis
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: