Edit

Share via


Add-DnsServerZoneScope

Adds a zone scope to an existing zone.

Syntax

Default (Default)

Add-DnsServerZoneScope
    [-ZoneName] <String>
    [-Name] <String>
    [-LoadExisting]
    [-PassThru]
    [-ComputerName <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Add-DnsServerZoneScope cmdlet adds a zone scope to an existing zone on the Domain Name System (DNS) server. A DNS server can load an existing scope from its data file. The name of the scope should adhere to the same conventions as the zone name. The scope name cannot be same as the zone name to which this cmdlet adds it.

When a scope is created, its data is persisted in a file named %Systemroot%\system32\dns\<zone name>\<scope name>.dns.

Examples

Example 1: Add a scope on a zone

PS C:\> Add-DnsServerZoneScope -ZoneName "contoso.com" -Name "contoso_NorthAmerica" -Verbose -PassThru
VERBOSE: A scope contoso_NorthAmerica will be added for the zone contoso.com on server Server17.

ZoneScope                 FileName
---------                 --------
contoso_NorthAmerica      contoso_NorthAmerica.dns

This command adds a scope on an existing zone named contoso.com.

Example 2: Add a scope on a zone with existing file

PS C:\> Add-DnsServerZoneScope -ZoneName "contoso.com" -Name "contoso_NorthAmerica" -LoadExisting -PassThru
ZoneScope                 FileName
---------                 --------
contoso_NorthAmerica      contoso_NorthAmerica.dns

This command adds a scope on an existing zone named contoso.com. The command specifies the LoadExisting parameter, so the server loads the scope from an existing file.

Example 3: Add a cache scope

PS C:\> Add-DnsServerZoneScope -ZoneName "..cache" -Name "ContosoScope" -PassThru
ZoneScope             FileName
---------             --------
ContosoScope          cache.dns

This command adds a cache scope named ContosoScope.

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 remote DNS server. You can specify an IP address or any 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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

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

-LoadExisting

Indicates that the server loads an existing file for the zone. If you do not specify this parameter, the cmdlet creates default zone records automatically.

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:True
Value from remaining arguments:False

-Name

Specifies a name for the zone scope.

Parameter properties

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

Parameter sets

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

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

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

-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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

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

-ZoneName

Specifies the name of a zone. This cmdlet adds a zone to the zone that this parameter specifies.

Parameter properties

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

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
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.

Outputs

CimInstance