Add-DnsServerResourceRecordDnsKey
Add-DnsServerResourceRecordDnsKey
Adds a type DNSKEY resource record to a DNS zone.
Syntax
Parameter Set: Add0
Add-DnsServerResourceRecordDnsKey [-ZoneName] <String> [-Name] <String> [-CryptoAlgorithm] <String> [-Base64Data] <String> [-AgeRecord] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-KeyProtocol <String> ] [-PassThru] [-SecureEntryPoint] [-ThrottleLimit <Int32> ] [-TimeToLive <TimeSpan> ] [-ZoneKey] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed 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.
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Base64Data<String>
Specifies key data for this resource record.
Aliases |
none |
Required? |
true |
Position? |
5 |
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 |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerName<String>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CryptoAlgorithm<String>
Specifies the cryptographic algorithm the server uses to generate keys. The acceptable values for this parameter are:
-- RsaSha1
-- RsaSha256
-- RsaSha512
-- RsaSha1NSec3
-- ECDsaP256Sha256
-- ECDsaP384Sha384
Aliases |
none |
Required? |
true |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-KeyProtocol<String>
Specifies the key protocol for this resource record. The only value for this parameter is DnsSec.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the resource record that this cmdlet adds to the DNS server.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SecureEntryPoint
Specifies whether the key is a secure entry point, as defined in RFC 3757.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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 |
-TimeToLive<TimeSpan>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ZoneName<String>
Specifies the name of a DNS zone.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Management.Infrastructure.CimInstance#DnsServerResourceRecord
Examples
Example 1: Add a DNSKEY resource record to a different computer
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.
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" }