Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Enable-TlsSessionTicketKey

Enable-TlsSessionTicketKey

microsoft.windowsauthenticationprotocols.commands.dll

Synopsis

Configures a TLS server with a TLS session ticket key.

Syntax

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

Detailed 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.

Parameters

-Force <SwitchParameter>

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.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Password <SecureString>

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

Aliases

none

Required?

true

Position

1

Default value

none

Accept pipeline input?

True (ByValue, ByPropertyName)

Accept wildcard characters?

false

-Path <String>

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

Aliases

FullName

Required?

true

Position

2

Default value

none

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ServiceAccountName <NTAccount>

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.

Aliases

none

Required?

true

Position

3

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

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

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.

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

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

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.

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

Online Version
New-TlsSessionTicketKey
Export-TlsSessionTicketKey
Disable-TlsSessionTicketKey