Get-DhcpServerv6DnsSetting

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

Syntax

Get-DhcpServerv6DnsSetting
   [[-Prefix] <IPAddress>]
   [[-IPAddress] <IPAddress>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-ComputerName <String>]
   [-ThrottleLimit <Int32>]
   [<CommonParameters>]

Description

The Get-DhcpServerv6DnsSetting cmdlet gets the DNS settings configured on the Dynamic Host Configuration Protocol (DHCP) server service for a specific scope, reservation, or server-wide.

If you specify neither the Prefix or IPAddress parameters, the DNS settings at the server level are retrieved. If you specify the Prefix or IPAddress parameter, this cmdlet gets the effective DNS setting at the specified level such as reservation, scope, or server. If the DNS setting value is not configured at the specified level, the DNS settings from the level above are retrieved, if they are configured. If the DNS setting is not specified at the server level, the default behavior of the DHCP server service such as DNS update is returned.

Examples

Example 1: Get the server-level DNS registration setting

PS C:\> Get-DhcpServerv6DnsSetting -ComputerName "dhcpserver.contoso.com"

This example gets the DHCPv6 server-level or server-wide DNS registration setting.

Example 2: Get the DNS registration setting for a scope

PS C:\> Get-DhcpServerv6DnsSetting -ComputerName "dhcpserver.contoso.com" -Prefix 2001:4898:7020:1020::

This example gets the DNS registration setting configured for the scope 2001:4898:7020:1020::.

Example 3: Get the DNS registration setting for a reserved address

PS C:\> Get-DhcpServerv6DnsSetting -ComputerName "dhcpserver.contoso.com" -IPAddress 2001:4898:7020:1020::10

This example gets the DNS registration setting configured for the reserved IP address 2001:4898:7020:1020:10.

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

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters: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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ComputerName

Specifies the DNS name, or IPv4 or IPv6 address, of the target computer that runs the DHCP server service.

Type:String
Aliases:Cn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-IPAddress

Specifies the IPv6 address of the reservation for which the DNS settings are retrieved.

Type:IPAddress
Aliases:ReservedIP
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Prefix

Specifies the subnet prefix of the IPv6 scope for which the DNS settings are retrieved.

Type:IPAddress
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters: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.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

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.

Inputs

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

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.