Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Enable-TlsSessionTicketKey

Last Updated: 2/14/2017

SYNOPSIS

Configures a TLS server with a TLS session ticket key.

SYNTAX

Enable-TlsSessionTicketKey [-ServiceAccountName] <NTAccount> [-Path] <String> [-Password] <SecureString>
 [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Enable-TlsSessionTicketKey cmdlet configures a Transport Layer Security (TLS) server with an administrator-managed TLS session ticket key, created with New-TlsSessionTicketKey, and configures the rule that uses the key for the application service account. For example, Internet Information Services (IIS) runs under System account so the ServiceAccountName parameter should be System.

TLS creates a session ticket by using the TLS Session Resumption without Server-Side State mechanism. For more information, see New-TlsSessionTicketKey or type Get-Help New-TlsSessionTicketKey.

EXAMPLES

Example 1: Configure a TLS server with a TLS session ticket key for the NetworkService account

PS C:\>$Password = Read-Host -AsSecureString
PS C:\> Enable-TlsSessionTicketKey -Password $Password -Path "C:\KeyConfig\TlsSessionTicketKey.config" -ServiceAccountName "NetworkService"

The second command configures the session ticket key for the TLS server. The command specifies the path for the configuration file on the TLS server, and specifies that the TLS session use the password stored in $Password to access the configuration file and configure the key for the specified service account.

Example 2: Configure a TLS server with a TLS session ticket key for System account

PS C:\>$Password = Read-Host -AsSecureString
PS C:\> Enable-TlsSessionTicketKey -Password $Password -Path "C:\KeyConfig\TlsSessionTicketKey.config" -ServiceAccountName "System"

The second command configures the session ticket key for the TLS server. The command specifies the path for the configuration file on the TLS server, and specifies that the TLS session use the password stored in $Password to access the configuration file and configure the key for the specified service account.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-Force

Forces the command to run without asking for user confirmation.

If you specify this parameter, the cmdlet overwrites the existing session ticket key and configuration.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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

-Password

Specifies the password, as a secure string, for the configuration file of the TLS server.

Type: SecureString
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Path

Specifies the path of the configuration file for the TLS server.

Type: String
Parameter Sets: (All)
Aliases: FullName

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ServiceAccountName

Specifies the name of a service account. The cmdlet configures the TLS session ticket key for the service account. Only System, LocalService, NetworkService, and SID of virtual accounts are supported.

Type: NTAccount
Parameter Sets: (All)
Aliases: 

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

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
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

OUTPUTS

NOTES

New-TlsSessionTicketKey

Export-TlsSessionTicketKey

Disable-TlsSessionTicketKey

© 2017 Microsoft