TSIG key

Set-EdnsTSIGKey

Synopsis

Update TSIG key for multiple zones.

Syntax

attributes (Default)

Set-EdnsTSIGKey -TSIGKeyAlgorithm <String> -TSIGKeyName <String> -TSIGKeySecret <String>
 [-TSIGKeyZoneCount <Int32>] -Zones <Object> [-EdgeRCFile <String>] [-Section <String>]
 [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

postbody

Set-EdnsTSIGKey [-Body <Object>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Updates the key data for multiple zones at once. This operation can only add zones to a TSIG key, not remove them.

To safely remove the association between a zone and a TSIG key, update the zone to its new TSIG key or remove the key from the zone if you're sure it's no longer needed.

Parameters

-AccountSwitchKey

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Run the Get-AccountSwitchKey command to list the account switch keys available to you.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Body

Request body, either as a PSCustomObject or string. This parameter supports pipelining.

Type: Object
Parameter Sets: postbody
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TSIGKeyAlgorithm

The algorithm used to encode the TSIG key's secret data.

Type: String
Parameter Sets: attributes
Aliases: algorithm
Accepted values: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384, hmac-sha512, HMAC-MD5.SIG-ALG.REG.INT

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TSIGKeyName

The name of the TSIG key. This is a name that's unique across all of Akamai's customers. Since the key name is treated like a DNS name, the value is lowercase and the server removes any trailing dots.

Type: String
Parameter Sets: attributes
Aliases: name

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TSIGKeySecret

A Base64-encoded string of data. When decoded, it needs to contain the correct number of bits for the chosen algorithm. If the input is not correctly padded, the server applies the padding.

Type: String
Parameter Sets: attributes
Aliases: secret

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TSIGKeyZoneCount

The number of zones that reference this key.

Type: Int32
Parameter Sets: attributes
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Zones

A list of zone names.

Type: Object
Parameter Sets: attributes
Aliases: zone

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.Object

Outputs