Set-DhcpServerv6DnsSetting
Set-DhcpServerv6DnsSetting
Configures how the Dynamic Host Configuration Protocol (DHCP) server service updates the DNS server with the client-related information.
Syntax
Parameter Set: Set1
Set-DhcpServerv6DnsSetting [[-Prefix] <IPAddress> ] [[-IPAddress] <IPAddress> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-DeleteDnsRROnLeaseExpiry <Boolean> ] [-DynamicUpdates <String> ] [-NameProtection <Boolean> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-DhcpServerv6DnsSetting cmdlet configures how the Dynamic Host Configuration Protocol (DHCP) server service updates the DNS server with the client-related information. The Prefix or IPAddress parameter must be specified with at least one of the optional parameters. The Prefix and IPAddress cannot both be specified. If neither the Prefix nor IPAddress parameter is specified, then this cmdlet sets DNS update setting at the server level.
This cmdlet modifies the effective DNS update setting and sets it on the specified reservation, scope, or server level.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<CimSession[]>
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerName<String>
Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DeleteDnsRROnLeaseExpiry<Boolean>
Specifies that the DHCP server service should delete the DNS resource records for the DHCP client after the lease expires.
The acceptable values for this parameter are: $true or $false. This parameter can only be set if the DynamicUpdate parameter is set to Always or OnClientRequest.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DynamicUpdates<String>
Specifies the conditions under which to perform dynamic updates on the DNS server.
The acceptable values for this parameter are: Always, Never, or OnClientRequest.
-- Always: The DHCP server service will always perform dynamic DNS registration of A and PTR records for the DHCP clients.
-- Never: The DHCP server service will not perform any dynamic DNS registration.
-- OnClientRequest: The DHCP server service will perform dynamic DNS registration of A and PTR records if the DHCP client has requested for the same in the DHCP client message.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-IPAddress<IPAddress>
Specifies the IPv6 address of the reservation on which the DNS update behavior is being configured.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-NameProtection<Boolean>
Sets the enabled state for the name protection on the DHCP server service.
If this parameter is specified and there is an existing DNS record already by the same name, then the DNS update for the client will fail instead of being overwritten.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Prefix<IPAddress>
Specifies the subnet prefix of the IPv6 scope on which the DNS update behavior is being configured.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0
is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6DnsSetting
The
Microsoft.Management.Infrastructure.CimInstance
object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#
) provides the namespace and class name for the underlying WMI object.Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Reservation
The
Microsoft.Management.Infrastructure.CimInstance
object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#
) provides the namespace and class name for the underlying WMI object.Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope
The
Microsoft.Management.Infrastructure.CimInstance
object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#
) provides the namespace and class name for the underlying WMI object.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6DnsSetting
The
Microsoft.Management.Infrastructure.CimInstance
object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#
) provides the namespace and class name for the underlying WMI object.
Examples
EXAMPLE 1
This example sets the DHCPv6 server level, or server-wide, DNS update configuration settings to always update DNS with leases entries, enables NAP protection by creating dynamic host configuration identifier (DHCID) resource records, and deletes the client entry from the DNS server when the lease expires.
PS C:\> Set-DhcpServerv6DnsSetting -ComputerName dhcpserver.contoso.com -DynamicUpdates Always -DeleteDnsRRonLeaseExpiry $true
EXAMPLE 2
This example sets the DNS update configuration settings for scope 2001:4898:7020:1020:: to update the DNS server with lease entries based on client request using the fully qualified domain name (FQDN) option (ID 81
), and enables name protection by creating dynamic host configuration identifier (DHCID) resource records.
PS C:\> Set-DhcpServerv6DnsSetting -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -DynamicUpdates OnClientRequest -NameProtection $true
EXAMPLE 3
This example sets the DNS update configuration settings for the reserved IP address 2001:4898:7020:1020::5 to never update the DNS server for client lease entries.
PS C:\> Set-DhcpServerv6DnsSetting -ComputerName dhcpserver.contoso.com -IPAddress 2001:4898:7020:1020::5 -DynamicUpdates Never