Set-DhcpServerv4DnsSetting

Set-DhcpServerv4DnsSetting

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

Syntax

Parameter Set: Set1
Set-DhcpServerv4DnsSetting [[-ScopeId] <IPAddress> ] [[-IPAddress] <IPAddress> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-DeleteDnsRROnLeaseExpiry <Boolean> ] [-DisableDnsPtrRRUpdate <Boolean> ] [-DnsSuffix <String> ] [-DynamicUpdates <String> ] [-NameProtection <Boolean> ] [-PassThru] [-PolicyName <String> ] [-ThrottleLimit <Int32> ] [-UpdateDnsRRForOlderClients <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-DhcpServerv4DnsSetting cmdlet configures how the Dynamic Host Configuration Protocol (DHCP) server service updates the DNS server by using the client-related information. This cmdlet modifies the effective DNS update setting and sets the setting on the server or the specified scope, policy or reservation.

Specify at least one parameter related to DNS update settings from the following parameters:

-- DeleteDnsRROnLeaseExpiry
-- DynamicUpdates
-- NameProtection
-- UpdateDnsRRForOlderClients
-- DnsSuffix
-- DisableDnsPtrRRUpdate

If you do not specify any of the ScopeId, IPAddress, or PolicyName parameters together with the parameters for DNS update settings, the specified DNS update settings are set for the server level.

If you specify ScopeId, the DNS settings are set for the scope. If you specify PolicyName, the DNS settings are set for the server level policy. If you specify both ScopeId and PolicyName, the DNS settings are set for the scope level policy.

If you specify IPAddress, the DNS settings are set for the reservation. Do not specify IPAddress with ScopeID or PolicyName.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


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

Session

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 that runs the DHCP server service.


Aliases

Cn

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 client after the lease expires. 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

-DisableDnsPtrRRUpdate<Boolean>

Indicates whether the DHCP server performs the dynamic DNS registration of only A records. If this value is $True, the DHCP server performs registration for only A records. If this value is $False, the server performs registration of both A and PTR records.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-DnsSuffix<String>

Specifies a guest DNS suffix for registering DHCP clients with the DNS server. The string must contain at least one character and cannot exceed 256 characters. Do not specify this parameter unless you specify the PolicyName parameter.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

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. The DHCP server service always performs dynamic DNS registration of A and PTR records for the clients.
-- Never. The DHCP server service does not perform any dynamic DNS registration
-- OnClientRequest. The DHCP server service performs dynamic DNS registration of A and PTR records if the client has requested 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 IPv4 address of the reservation for which the specified DNS update settings are being set.


Aliases

ReservedIP

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-NameProtection<Boolean>

Specifies the enabled state for the DNS name protection on the DHCP server service. If this parameter is set to True, DNS name protection is enabled. If this parameter is set to True and there is an existing DNS record matching the name, the DNS update for the client fails 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

-PolicyName<String>

Specifies the name of a policy.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ScopeId<IPAddress>

Specifies the scope identifier, in IPv4 address format, for which the DNS update settings are set.


Aliases

none

Required?

false

Position?

2

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

-UpdateDnsRRForOlderClients<Boolean>

Specifies the enabled state for the DNS registration of A and PTR records for older clients which do not request DNS updates.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

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: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Set server level configuration settings

This example sets the server level, or server-wide, DNS update configuration settings to always update DNS with leases entries and deletes the client entry from DNS when the lease expires.


PS C:\> Set-DhcpServerv4DnsSetting -ComputerName "dhcpserver.contoso.com" -DynamicUpdates "Always" -DeleteDnsRRonLeaseExpiry $True

Example 2: Set configuration settings for a scope

This example sets the DNS update configuration settings for scope 10.10.10.0 to update the DNS with leases entries based on client request, indicated in the FQDN option (option ID 81), and enables name protection by creating dynamic host configuration identifier (DHCID) resource records.


PS C:\> Set-DhcpServerv4DnsSetting -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0 -DynamicUpdates "OnClientRequest" -NameProtection $True

Example 3: Set update configuration settings

This example sets the DNS update configuration settings for the reserved IP address 10.10.10.5 to never update the DNS for client lease entries. This cmdlet clears all of the properties other than the property that is specified.


PS C:\> Set-DhcpServerv4DnsSetting -ComputerName "dhcpserver.contoso.com" -IPAddress 10.10.10.5 -DynamicUpdates "Never"

Example 4: Set update configuration settings for a server policy with DisableDnsPtrRRUpdates

This example sets DNS update configuration settings for the sever policy WorkgroupDevices to disable DNS dynamic updates for PTR records. The command specifies the computer, named dhcpserver.contoso.com, that runs the DHCP server service.


PS C:\> Set-DhcpServerv4DnsSetting -ComputerName "dhcpserver.contoso.com" -DisableDnsPtrRRUpdates $True -PolicyName "WorkgroupDevices" 

Example 5: Set update configuration settings for a server policy

This example sets DNS update configuration settings for the sever policy ForeignDevices to enable DNS registration of clients under the DNS suffix guestdomain.com. The command specifies the computer, named dhcpserver.contoso.com, that runs the DHCP server service.


PS C:\> Set-DhcpServerv4DnsSetting -ComputerName "dhcpserver.contoso.com" -DnsSuffix "guestdomain.com" -PolicyName "ForeignDevices" 

Related topics

Community Additions

ADD
Show: