Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-DnsServerTrustAnchor

Add-DnsServerTrustAnchor

ps_dnsservertrustanchor_v1.0.0.cdxml

Synopsis

Adds a trust anchor to a DNS server.

Syntax

Add-DnsServerTrustAnchor [-Name] [-CryptoAlgorithm] [-AsJob] [-CimSession] [-ComputerName] [-KeyProtocol] [-PassThru] [-ThrottleLimit] [-Base64Data] [-Confirm] [-WhatIf] [<CommonParameters>]

Add-DnsServerTrustAnchor [-Name] [-CryptoAlgorithm] [-AsJob] [-CimSession] [-ComputerName] [-PassThru] [-ThrottleLimit] [-Digest] [-DigestType] [-KeyTag] [-Confirm] [-WhatIf] [<CommonParameters>]

Add-DnsServerTrustAnchor [-AsJob] [-CimSession] [-ComputerName] [-PassThru] [-ThrottleLimit] [-Root] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Add-DnsServerTrustAnchor cmdlet adds a trust anchor (DNSKEY record or DS record) to a DNS server. If no trust anchor is present, the cmdlet creates one. If you specify the DigestType parameter, the cmdlet adds a trust anchor delegation signer (DS) record.

If you specify the Root parameter the cmdlet retrieves the trust anchors from the URL specified in RootTrustAnchorsURL property of the DNS server.

Parameters

-AsJob <SwitchParameter>

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

-Base64Data <String>

Specifies key data.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

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 a remote DNS server. The acceptable values for this parameter are: 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.

Aliases

Cn

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CryptoAlgorithm <String>

Specifies the cryptographic algorithm that the cmdlet uses for key generation.

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Digest <String>

Specifies the DS digest data.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DigestType <String>

Specifies the type of algorithm that the zone signing key uses to create the DS record. Valid values are one or more of the following: -- Sha1 -- Sha256 -- Sha384

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-KeyProtocol <String>

Specifies the protocol name. The default is DNSSEC.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-KeyTag <UInt16>

Specifies the unique key tag that the DNS server uses to identify a key.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Specifies the name of a trust anchor on a DNS server.

Aliases

TrustAnchorName

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

-Root <SwitchParameter>

Indicates that the cmdlet adds the trust anchor of the root zone from the URL specified by the RootTrustAnchorsURL property of the DNS server.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

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

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

Microsoft.Management.Infrastructure.CimInstance#DnsServerTrustAnchor

Notes

None

Examples

Example 1: Add a trust anchor to a DNS server

This command uses the Get-DnsServerResourceRecord cmdlet to obtain a DnsKey resource record from the DNS server DNS1 for the zone named sec.contoso.com. The command then uses the pipe operator to send it to the Add-DnsServerTrustAnchor cmdlet to add a trust anchor to the current DNS server for this zone.

PS C:\>Get-DnsServerResourceRecord -ZoneName "sec.contoso.com" -RRType "dnskey" –ComputerName DNS1 | %{ $_.RecordData | Add-DnsServerTrustAnchor -PassThru -Verbose -Name "sec.contoso.com"}
VERBOSE: Adding trust anchor for trust point sec.contoso.com of type DNSKEY on server Server01. 


TrustAnchorName             TrustAnchorType      TrustAnchorState     TrustAnchorData

---------------              ---------------      ----------------     ---------------

sec.contoso.com             DNSKEY               Valid                [23600][DnsSec][RsaSha256][AwEAAbZvBTiMzoqK... 

VERBOSE: Adding trust anchor for trust point sec.contoso.com of type DNSKEY on server Server01. 

sec.contoso.com             DNSKEY               Valid                [53180][DnsSec][RsaSha256][AwEAAbsS7NnziyRY... 

VERBOSE: Adding trust anchor for trust point sec.contoso.com of type DNSKEY on server Server01. 

sec.contoso.com             DNSKEY               Valid                [50272][DnsSec][RsaSha256][AwEAAe1EkxNj6M1b... 

VERBOSE: Adding trust anchor for trust point sec.contoso.com of type DNSKEY on server Server01. 

sec.contoso.com             DNSKEY               Valid                [37436][DnsSec][RsaSha256][AwEAAa1PJyk2lITB... 

VERBOSE: Adding trust anchor for trust point sec.contoso.com of type DNSKEY on server Server01. 

sec.contoso.com             DNSKEY               Valid                [2895][DnsSec][RsaSha1NSec3][AwEAAbOk5nl41M... 

VERBOSE: Adding trust anchor for trust point sec.contoso.com of type DNSKEY on server Server01. 

sec.contoso.com             DNSKEY               Valid                [62250][DnsSec][RsaSha1NSec3][AwEAAci9Ayfjg... 

VERBOSE: Adding trust anchor for trust point sec.contoso.com of type DNSKEY on server Server01. 

sec.contoso.com             DNSKEY               Valid                [47244][DnsSec][RsaSha1NSec3][AwEAAcFv94ne6...

Example 2: Add a trust anchor from the RootTrustAnchorsURL property

This command adds the trust anchors from the URL specified by the RootTrustAnchorsURL property of the DNS server.

PS C:\>Add-DnsServerTrustAnchor -Root

Online Version
Get-DnsServerTrustAnchor
Import-DnsServerTrustAnchor
Remove-DnsServerTrustAnchor
Get-DnsServerResourceRecord