Enable-TlsSessionTicketKey
Configures a TLS server with a TLS session ticket key.
Syntax
Default (Default)
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
$Password = Read-Host -AsSecureString
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
$Password = Read-Host -AsSecureString
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Password
Specifies the password, as a secure string, for the configuration file of the TLS server.
Parameter properties
| Type: | SecureString |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Path
Specifies the path of the configuration file for the TLS server.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | FullName |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | NTAccount |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.