Edit

Share via


Get-DnsServerEncryptionProtocol

Retrieves DNS server encryption protocol settings for DNS over HTTPS (DoH) on Windows Server 2025 or later.

Syntax

Default (Default)

Get-DnsServerEncryptionProtocol
    [-ComputerName <String>]
    [-PassThru <Boolean>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

Description

The Get-DnsServerEncryptionProtocol cmdlet can be used to verify the current DoH configuration on a DNS server. The cmdlet retrieves the current settings as an object with the properties EnableDoh and UriTemplate to indicate whether DoH is enabled and the configured URI templates for DNS queries over HTTPS. The cmdlet retrieves the persistent encryption protocol settings. Changes made using Set-DnsServerEncryptionProtocol require a DNS server restart to take effect before being retrieved.

Important

The Get-DnsServerEncryptionProtocol cmdlet is available on Windows Server 2025 or later beginning with 2026-02 Security Update.

Examples

Example 1: Retrieve encryption settings from local DNS server

In this example, the command retrieves the current encryption settings from the local DNS server.

Get-DnsServerEncryptionProtocol
EnableDoh   : True
UriTemplate : https://dnsserver.example.net/dns-query

The output shows that DNS over HTTPS (DoH) is enabled with a configured URI template.

Example 2: Retrieve encryption settings from remote DNS server

In this example, the command retrieves the encryption settings from a remote DNS server named "dns1.contoso.com".

Get-DnsServerEncryptionProtocol -ComputerName "dns1.contoso.com"
EnableDoh   : False
UriTemplate :

The output shows that DNS over HTTPS (DoH) is currently disabled for the specified remote DNS server.

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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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.

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ComputerName

Specifies a DNS server. The acceptable values for this parameter are:

  • An IP V4 address
  • An IP V6 address
  • Any other value that resolves to an IP address, such as a fully qualified domain name (FQDN), host name, or NETBIOS name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Cn

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Returns an object representing the item with which you are working.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ThrottleLimit

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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You cannot pipe objects to this cmdlet.

Outputs

CimInstance

This cmdlet returns a DnsServerEncryptionProtocol object that represents the updated encryption protocol settings on the DNS server.