Add-DnsServerResourceRecordDnsKey
Adds a type DNSKEY resource record to a DNS zone.
Syntax
Add-DnsServerResourceRecordDnsKey
[-Name] <String>
[-CryptoAlgorithm] <String>
[-ZoneName] <String>
[-TimeToLive <TimeSpan>]
[-AgeRecord]
[-Base64Data] <String>
[-KeyProtocol <String>]
[-ComputerName <String>]
[-SecureEntryPoint]
[-ZoneKey]
[-PassThru]
[-ZoneScope <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Add-DnsServerResourceRecordDNSKEY cmdlet adds DNSKEY resource record to a Domain Name System (DNS) server. DNSKEY is a DNS Security Extensions (DNSSEC) element that stores a public key. You most often use this cmdlet to add DNSKEY records to the TrustAnchors zone.
The AgeRecord parameter is not relevant for DS resource records.
If you do not specify either SecureEntryPoint or ZoneSigningKey, the cmdlet creates a trust anchor with the Secure Entry Point (SEP) bit set.
Examples
Example 1: Add a DNSKEY resource record to a different computer
PS C:\> $DNSKEYS = Get-DnsServerResourceRecord -RRType DnsKey -ZoneName "contoso.com" -ComputerName "dnsserver.contoso.com"
PS C:\> $DNSKEYS | %{ $_.RecordData | Add-DnsServerResourceRecordDnsKey -ZoneName "TrustAnchors" -Name "contoso.com" -ComputerName "dnsresolver.contoso.com" }This example adds a DNSKEY resource record of the zone named contoso.com from the server named dnsserver.contoso.com to the server named dnsresolver.contoso.com.
The first command gets the DNSKEY resource record and stores it in the variable named $DNSKEYS.
The second command gets the DNSKEY resource record from $DSNKEYS and stores the resource record in the zone named TrustAnchors on the server named dnsresolver.contoso.com.
Parameters
-AgeRecord
Indicates that the DNS server uses a time stamp for the resource record that this cmdlet adds. A DNS server can scavenge resource records that have become stale based on a time stamp.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Base64Data
Specifies key data for this resource record.
| Type: | String |
| Position: | 4 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputerName
Specifies a DNS server. If you do not specify this parameter, the command runs on the local system. 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.
| Type: | String |
| Aliases: | Cn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CryptoAlgorithm
Specifies the cryptographic algorithm the server uses to generate keys. The acceptable values for this parameter are:
- RsaSha1
- RsaSha256
- RsaSha512
- RsaSha1NSec3
- ECDsaP256Sha256
- ECDsaP384Sha384
| Type: | String |
| Accepted values: | RsaSha1, RsaSha256, RsaSha512, RsaSha1NSec3, ECDsaP256Sha256, ECDsaP384Sha384 |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-KeyProtocol
Specifies the key protocol for this resource record. The only value for this parameter is Dnssec.
| Type: | String |
| Accepted values: | DnsSec |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies the name of the resource record that this cmdlet adds to the DNS server.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SecureEntryPoint
Specifies whether the key is a secure entry point, as defined in RFC 3757.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TimeToLive
Specifies the Time to Live (TTL) value, in seconds, for a resource record. Other DNS servers use this length of time to determine how long to cache a record.
| Type: | TimeSpan |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ZoneKey
Specifies whether you can use this key to sign the zone. This key can be either a Zone Signing Key (ZSK) or a Key Signing Key (KSK).
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ZoneName
Specifies the name of a DNS zone.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ZoneScope
Specifies the name of a zone scope.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |